@inductiv/node-red-openai-api 0.3.6 → 0.3.8

package/lib.js

@@ -22,6 +22,11 @@ var OpenaiApi = (function () {
     setApiBase(apiBase) {
       this.domain = apiBase;
     }
+
+    setOrganizationIdHeader(organizationId) {
+      this.organizationId = organizationId;
+    }
+
     setAuthHeaders(headerParams) {
       var headers = headerParams ? headerParams : {};
       if (!this.apiKey.isQuery && this.apiKey.headerOrQueryName) {
@@ -30,18 +35,22 @@ var OpenaiApi = (function () {
       return headers;
     }
 
-    setNodeRef(node){
+    setNodeRef(node) {
       this.node = node;
     }
 
-    getFromEndpoint(path, parameters, expectedQueryParams, customHeaders) {
+    getFromEndpoint(path, parameters, expectedQueryParams, customHeaders = {}) {
       return new Promise((resolve, reject) => {
         var domain = this.domain;
-        var queryParameters = {},
-          baseHeaders = {};
+        var organizationId = this.organizationId;
+        var queryParameters = {};
+        var baseHeaders = {};
 
         baseHeaders = this.setAuthHeaders(headers);
         baseHeaders["Accept"] = "application/json";
+        if (organizationId) {
+          customHeaders["OpenAI-Organization"] = organizationId;
+        }
 
         var headers = {
           ...baseHeaders,
@@ -78,26 +87,32 @@ var OpenaiApi = (function () {
           });
       });
     }
+
     postToEndpoint(
       path,
       parameters,
       expectedQueryParams,
       contentType,
       filePath,
-      customHeaders,
+      customHeaders = {},
     ) {
       return new Promise((resolve, reject) => {
         const _path = require("path");
 
         parameters = parameters || {};
         var domain = this.domain;
+        var organizationId = this.organizationId;
         var queryParameters = {},
           baseHeaders = {},
           data;
 
-        baseHeaders = this.setAuthHeaders({});
+        baseHeaders = this.setAuthHeaders(baseHeaders);
         baseHeaders["Accept"] = "application/json";
 
+        if (organizationId) {
+          customHeaders["OpenAI-Organization"] = organizationId;
+        }
+
         var headers = {
           ...baseHeaders,
           ...customHeaders,
@@ -153,26 +168,29 @@ var OpenaiApi = (function () {
           headers: headers,
           params: queryParameters,
           data: data,
-          responseType: data.stream === true ? "stream" : "json"
+          responseType: data.stream === true ? "stream" : "json",
         };
 
         axios(config)
           .then((response) => {
             if (config.responseType === "stream") {
               // Handle the stream response
-              response.data.on('data', (chunk) => {
-                // Convert chunk from Uint8Array to string
-                const chunkAsString = new TextDecoder().decode(chunk);
-        
-                // Emit converted data chunks as Node-RED messages
-                this.node.send({ payload: chunkAsString });
-              }).on('end', () => {
-                // Handle the end of the stream
-                resolve({ payload: "Stream ended" });
-              }).on('error', (err) => {
-                // Handle any errors
-                reject(err);
-              });
+              response.data
+                .on("data", (chunk) => {
+                  // Convert chunk from Uint8Array to string
+                  const chunkAsString = new TextDecoder().decode(chunk);
+
+                  // Emit converted data chunks as Node-RED messages
+                  this.node.send({ payload: chunkAsString });
+                })
+                .on("end", () => {
+                  // Handle the end of the stream
+                  resolve({ payload: "Stream ended" });
+                })
+                .on("error", (err) => {
+                  // Handle any errors
+                  reject(err);
+                });
             } else {
               // Handle non-stream response (e.g., JSON)
               resolve(response);
@@ -184,16 +202,26 @@ var OpenaiApi = (function () {
       });
     }
 
-    deleteFromEndpoint(path, parameters, expectedQueryParams, customHeaders) {
+    deleteFromEndpoint(
+      path,
+      parameters,
+      expectedQueryParams,
+      customHeaders = {},
+    ) {
       return new Promise((resolve, reject) => {
         parameters = parameters || {};
         var domain = this.domain;
+        var organizationId = this.organizationId;
         var queryParameters = {},
           baseHeaders = {};
 
         baseHeaders = this.setAuthHeaders(headers);
         baseHeaders["Accept"] = "application/json";
 
+        if (organizationId) {
+          customHeaders["OpenAI-Organization"] = organizationId;
+        }
+
         var headers = {
           ...baseHeaders,
           ...customHeaders,
@@ -229,6 +257,7 @@ var OpenaiApi = (function () {
           });
       });
     }
+
     createChatCompletion(parameters) {
       const response = this.postToEndpoint("/chat/completions", parameters);
       return response;
@@ -315,14 +344,17 @@ var OpenaiApi = (function () {
     }
     deleteFile(parameters) {
       const file_id = parameters.body.file_id;
+      delete parameters.body.file_id;
       return this.deleteFromEndpoint(`/files/${file_id}`, parameters);
     }
     retrieveFile(parameters) {
       const file_id = parameters.body.file_id;
+      delete parameters.body.file_id;
       return this.getFromEndpoint(`/files/${file_id}`, parameters);
     }
     downloadFile(parameters) {
       const file_id = parameters.body.file_id;
+      delete parameters.body.file_id;
       return this.getFromEndpoint(`/files/${file_id}/content`, parameters);
     }
     createFineTuningJob(parameters) {
@@ -338,6 +370,7 @@ var OpenaiApi = (function () {
     }
     retrieveFineTuningJob(parameters) {
       const fine_tuning_job_id = parameters.body.fine_tuning_job_id;
+      delete parameters.body.fine_tuning_job_id;
       return this.getFromEndpoint(
         `/fine_tuning/jobs/${fine_tuning_job_id}`,
         parameters,
@@ -346,6 +379,7 @@ var OpenaiApi = (function () {
     listFineTuningEvents(parameters) {
       const expectedQueryParameters = ["after", "limit"];
       const fine_tuning_job_id = parameters.body.fine_tuning_job_id;
+      delete parameters.body.fine_tuning_job_id;
 
       return this.getFromEndpoint(
         `/fine_tuning/jobs/${fine_tuning_job_id}/events`,
@@ -355,6 +389,7 @@ var OpenaiApi = (function () {
     }
     cancelFineTuningJob(parameters) {
       const fine_tuning_job_id = parameters.body.fine_tuning_job_id;
+      delete parameters.body.fine_tuning_job_id;
       return this.postToEndpoint(
         `/fine_tuning/jobs/${fine_tuning_job_id}/cancel`,
         parameters,
@@ -365,12 +400,12 @@ var OpenaiApi = (function () {
     }
     retrieveModel(parameters) {
       const model = parameters.body.model;
-
+      delete parameters.body.model;
       return this.getFromEndpoint(`/models/${model}`, parameters);
     }
     deleteModel(parameters) {
       const model = parameters.body.model;
-
+      delete parameters.body.model;
       return this.deleteFromEndpoint(`/models/${model}`, parameters);
     }
     createModeration(parameters) {
@@ -401,9 +436,8 @@ var OpenaiApi = (function () {
     }
     getAssistant(parameters) {
       const assistantId = parameters.body.assistant_id;
-
-      var customHeaders = { "OpenAI-Beta": "assistants=v1" };
-
+      const customHeaders = { "OpenAI-Beta": "assistants=v1" };
+      delete parameters.body.assistant_id;
       return this.getFromEndpoint(
         `/assistants/${assistantId}`,
         parameters,
@@ -414,7 +448,7 @@ var OpenaiApi = (function () {
     modifyAssistant(parameters) {
       const assistant_id = parameters.body.assistant_id;
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
-
+      delete parameters.body.assistant_id;
       return this.postToEndpoint(
         `/assistants/${assistant_id}`,
         parameters,
@@ -427,7 +461,7 @@ var OpenaiApi = (function () {
     deleteAssistant(parameters) {
       const assistant_id = parameters.body.assistant_id;
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
-
+      delete parameters.body.assistant_id;
       return this.deleteFromEndpoint(
         `/assistants/${assistant_id}`,
         parameters,
@@ -449,7 +483,7 @@ var OpenaiApi = (function () {
     getThread(parameters) {
       const threadId = parameters.body.thread_id;
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
-
+      delete parameters.body.thread_id;
       return this.getFromEndpoint(
         `/threads/${threadId}`,
         parameters,
@@ -460,7 +494,7 @@ var OpenaiApi = (function () {
     modifyThread(parameters) {
       const threadId = parameters.body.thread_id;
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
-
+      delete parameters.body.thread_id;
       return this.postToEndpoint(
         `/threads/${threadId}`,
         parameters,
@@ -473,7 +507,7 @@ var OpenaiApi = (function () {
     deleteThread(parameters) {
       const threadId = parameters.body.thread_id;
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
-
+      delete parameters.body.thread_id;
       return this.deleteFromEndpoint(
         `/threads/${threadId}`,
         parameters,
@@ -484,9 +518,8 @@ var OpenaiApi = (function () {
     listMessages(parameters) {
       const threadId = parameters.body.thread_id;
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
-
       const expectedQueryParameters = ["limit", "order", "after", "before"];
-
+      delete parameters.body.thread_id;
       return this.getFromEndpoint(
         `/threads/${threadId}/messages`,
         parameters,
@@ -497,7 +530,7 @@ var OpenaiApi = (function () {
     createMessage(parameters) {
       const threadId = parameters.body.thread_id;
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
-
+      delete parameters.body.thread_id;
       return this.postToEndpoint(
         `/threads/${threadId}/messages`,
         parameters,
@@ -511,7 +544,8 @@ var OpenaiApi = (function () {
       const threadId = parameters.body.thread_id;
       const messageId = parameters.body.message_id;
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
-
+      delete parameters.body.thread_id;
+      delete parameters.body.message_id;
       return this.getFromEndpoint(
         `/threads/${threadId}/messages/${messageId}`,
         parameters,
@@ -523,7 +557,8 @@ var OpenaiApi = (function () {
       const threadId = parameters.body.thread_id;
       const messageId = parameters.body.message_id;
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
-
+      delete parameters.body.thread_id;
+      delete parameters.body.message_id;
       return this.postToEndpoint(
         `/threads/${threadId}/messages/${messageId}`,
         parameters,
@@ -549,7 +584,7 @@ var OpenaiApi = (function () {
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
       const expectedQueryParameters = ["limit", "order", "after", "before"];
       const threadId = parameters.body.thread_id;
-
+      delete parameters.body.thread_id;
       return this.getFromEndpoint(
         `/threads/${threadId}/runs`,
         parameters,
@@ -560,7 +595,7 @@ var OpenaiApi = (function () {
     createRun(parameters) {
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
       const threadId = parameters.body.thread_id;
-
+      delete parameters.body.thread_id;
       return this.postToEndpoint(
         `/threads/${threadId}/runs`,
         parameters,
@@ -574,7 +609,8 @@ var OpenaiApi = (function () {
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
       const threadId = parameters.body.thread_id;
       const runId = parameters.body.run_id;
-
+      delete parameters.body.thread_id;
+      delete parameters.body.run_id;
       return this.getFromEndpoint(
         `/threads/${threadId}/runs/${runId}`,
         parameters,
@@ -586,7 +622,8 @@ var OpenaiApi = (function () {
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
       const threadId = parameters.body.thread_id;
       const runId = parameters.body.run_id;
-
+      delete parameters.body.thread_id;
+      delete parameters.body.run_id;
       return this.postToEndpoint(
         `/threads/${threadId}/runs/${runId}`,
         parameters,
@@ -600,7 +637,8 @@ var OpenaiApi = (function () {
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
       const threadId = parameters.body.thread_id;
       const runId = parameters.body.run_id;
-
+      delete parameters.body.thread_id;
+      delete parameters.body.run_id;
       return this.postToEndpoint(
         `/threads/${threadId}/runs/${runId}/submit_tool_outputs`,
         parameters,
@@ -614,7 +652,8 @@ var OpenaiApi = (function () {
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
       const threadId = parameters.body.thread_id;
       const runId = parameters.body.run_id;
-
+      delete parameters.body.thread_id;
+      delete parameters.body.run_id;
       return this.postToEndpoint(
         `/threads/${threadId}/runs/${runId}/cancel`,
         parameters,
@@ -629,7 +668,8 @@ var OpenaiApi = (function () {
       const threadId = parameters.body.thread_id;
       const runId = parameters.body.run_id;
       const expectedQueryParameters = ["limit", "order", "after", "before"];
-
+      delete parameters.body.thread_id;
+      delete parameters.body.run_id;
       return this.getFromEndpoint(
         `/threads/${threadId}/runs/${runId}/steps`,
         parameters,
@@ -642,7 +682,8 @@ var OpenaiApi = (function () {
       const threadId = parameters.body.thread_id;
       const runId = parameters.body.run_id;
       const stepId = parameters.body.step_id;
-
+      delete parameters.body.thread_id;
+      delete parameters.body.step_id;
       return this.getFromEndpoint(
         `/threads/${threadId}/runs/${runId}/steps/${stepId}`,
         parameters,
@@ -654,7 +695,7 @@ var OpenaiApi = (function () {
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
       const assistantId = parameters.body.assistant_id;
       const expectedQueryParameters = ["limit", "order", "after", "before"];
-
+      delete parameters.body.assistant_id;
       return this.getFromEndpoint(
         `/assistants/${assistantId}/files`,
         parameters,
@@ -665,7 +706,7 @@ var OpenaiApi = (function () {
     createAssistantFile(parameters) {
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
       const assistantId = parameters.body.assistant_id;
-
+      delete parameters.body.assistant_id;
       return this.postToEndpoint(
         `/assistants/${assistantId}/files`,
         parameters,
@@ -679,7 +720,8 @@ var OpenaiApi = (function () {
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
       const assistantId = parameters.body.assistant_id;
       const fileId = parameters.body.file_id;
-
+      delete parameters.body.assistant_id;
+      delete parameters.body.file_id;
       return this.getFromEndpoint(
         `/assistants/${assistantId}/files/${fileId}`,
         parameters,
@@ -691,7 +733,8 @@ var OpenaiApi = (function () {
       const customHeaders = { "OpenAI-Beta": "assistants=v1" };
       const assistantId = parameters.body.assistant_id;
       const fileId = parameters.body.file_id;
-
+      delete parameters.body.assistant_id;
+      delete parameters.body.file_id;
       return this.deleteFromEndpoint(
         `/assistants/${assistantId}/files/${fileId}`,
         parameters,
@@ -704,7 +747,8 @@ var OpenaiApi = (function () {
       const threadId = parameters.body.thread_id;
       const messageId = parameters.body.message_id;
       const expectedQueryParameters = ["limit", "order", "after", "before"];
-
+      delete parameters.body.thread_id;
+      delete parameters.body.message_id;
       return this.getFromEndpoint(
         `/threads/${threadId}/messages/${messageId}/files`,
         parameters,
@@ -717,7 +761,9 @@ var OpenaiApi = (function () {
       const threadId = parameters.body.thread_id;
       const messageId = parameters.body.message_id;
       const fileId = parameters.body.file_id;
-
+      delete parameters.body.thread_id;
+      delete parameters.body.message_id;
+      delete parameters.body.file_id;
       return this.getFromEndpoint(
         `/threads/${threadId}/messages/${messageId}/files/${fileId}`,
         parameters,

package/locales/en-US/node.json

@@ -6,6 +6,7 @@
             "method": "Method",
             "host": "Host",
             "header": "Auth Header",
+            "organizationId": "Org Id",
             "apiKey": "API Key",
             "isQuery": "isQuery"
         },

package/node.html

@@ -715,6 +715,7 @@
         defaults: {
             apiBase: { value: "https://api.openai.com/v1", required: true },
             secureApiKeyHeaderOrQueryName: { value: "Authorization" },
+            organizationId: { value: "" },
             secureApiKeyIsQuery: { value: false },
             name: { value: "" },
         },
@@ -753,6 +754,10 @@
         <label id="node-config-input-secureApiKeyValue-label" for="node-config-input-secureApiKeyValue"><i class="fa fa-lock"></i> <span data-i18n="OpenaiApi.label.apiKey"></span></label>
         <input type="password" id="node-config-input-secureApiKeyValue" placeholder="">
     </div>
+    <div class="form-row">
+        <label id="node-config-input-organizationId-label" for="node-config-input-organizationId"><i class="fa fa-list"></i> <span data-i18n="OpenaiApi.label.organizationId"></span></label>
+        <input type="text" id="node-config-input-organizationId" placeholder="OpenAI Organization Id">
+    </div>
     <div class="form-row">
         <label id="node-config-input-secureApiKeyIsQuery-label" for="node-config-input-secureApiKeyIsQuery"><i class="fa fa-dot-circle-o"></i> <span data-i18n="OpenaiApi.label.isQuery"></span></label>
         <select id="node-config-input-secureApiKeyIsQuery">

package/node.js

@@ -15,6 +15,7 @@ module.exports = function (RED) {
                 let client = new lib.OpenaiApi();
                 if (!errorFlag && this.service) {
                     client.setApiBase(this.service.apiBase);
+                    client.setOrganizationIdHeader(this.service.organizationId);
                 }
 
                 if (!errorFlag && this.service && this.service.credentials && this.service.credentials.secureApiKeyValue) {
@@ -99,6 +100,7 @@ module.exports = function (RED) {
             this.apiBase = n.apiBase;
             this.secureApiKeyHeaderOrQueryName = n.secureApiKeyHeaderOrQueryName;
             this.secureApiKeyIsQuery = n.secureApiKeyIsQuery;
+            this.organizationId = n.organizationId;
         }
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inductiv/node-red-openai-api",
-  "version": "0.3.6",
+  "version": "0.3.8",
   "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": {