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

package/README.md

@@ -9,11 +9,10 @@
 
 _@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.6.0
+## New in Version 0.8.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.
+- **Bug Fix**: Fixed an issue introduced in v. 0.7.0 that caused the `createChatCompletion` endpoint to return duplicate messages.
+- **Enhancement**: Bumped the OpenAI API package dependency to version 4.36.0. Updated the node's documentation accordingly.
 
 Please report any issues [here on Github](https://github.com/allanbunch/node-red-openai-api/issues).
 
@@ -55,7 +54,6 @@ This package's configuration node is now named "Service Host" to serve as a more
 - [Installation](#installation)
 - [Usage](#usage)
 - [License](#license)
-- [Acknowledgements](#acknowledgements)
 
 ## Installation
 

package/lib.js

@@ -5,22 +5,24 @@ let OpenaiApi = (function () {
   const OpenAI = require("openai").OpenAI;
 
   class OpenaiApi {
+    constructor(apiKey, baseURL, organization) {
+      this.clientParams = {
+        apiKey: apiKey,
+        baseURL: baseURL,
+        organization: organization
+      }
+    }
+
     async createChatCompletion(parameters) {
       let node = parameters._node;
       delete parameters._node;
 
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
       const response = await openai.chat.completions.create({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
-      if (parameters.payload.stream) {
+      if (parameters.msg.payload.stream) {
         node.status({
           fill: "green",
           shape: "dot",
@@ -28,8 +30,11 @@ let OpenaiApi = (function () {
         });
         for await (const chunk of response) {
           if (typeof chunk === "object") {
-            let payload = { payload: chunk };
-            node.send(payload);
+            
+            let {_msgid, ...newMsg} = parameters.msg;
+            newMsg.payload = chunk;
+
+            node.send(newMsg);
           }
         }
         node.status({});
@@ -39,128 +44,99 @@ let OpenaiApi = (function () {
     }
 
     async createImage(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
       const response = await openai.images.generate({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
 
     async createImageEdit(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      parameters.payload.image = fs.createReadStream(parameters.payload.image);
-      if (parameters.payload.mask) {
-        parameters.payload.mask = fs.createReadStream(parameters.payload.mask);
+      const openai = new OpenAI(this.clientParams);
+
+      parameters.msg.payload.image = fs.createReadStream(
+        parameters.msg.payload.image,
+      );
+      if (parameters.msg.payload.mask) {
+        parameters.msg.payload.mask = fs.createReadStream(
+          parameters.msg.payload.mask,
+        );
       }
 
       const response = await openai.images.edit({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
 
     async createImageVariation(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      parameters.payload.image = fs.createReadStream(parameters.payload.image);
+      const openai = new OpenAI(this.clientParams);
+
+      parameters.msg.payload.image = fs.createReadStream(
+        parameters.msg.payload.image,
+      );
       const response = await openai.images.createVariation({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
 
     async createEmbedding(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
       const response = await openai.embeddings.create({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
 
     async createSpeech(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const audio = await openai.audio.speech.create({ ...parameters.payload });
+      const openai = new OpenAI(this.clientParams);
+
+      const audio = await openai.audio.speech.create({
+        ...parameters.msg.payload,
+      });
       const response = Buffer.from(await audio.arrayBuffer());
 
       return response;
     }
 
     async createTranscription(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
-      parameters.payload.file = fs.createReadStream(parameters.payload.file);
+      parameters.msg.payload.file = fs.createReadStream(
+        parameters.msg.payload.file,
+      );
 
       const response = await openai.audio.transcriptions.create({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
 
     async createTranslation(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      parameters.payload.file = fs.createReadStream(parameters.payload.file);
+      const openai = new OpenAI(this.clientParams);
+
+      parameters.msg.payload.file = fs.createReadStream(
+        parameters.msg.payload.file,
+      );
       const response = await openai.audio.translations.create({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
 
     async listFiles(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
       const list = await openai.files.list({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       let files = [];
@@ -172,92 +148,69 @@ let OpenaiApi = (function () {
     }
 
     async createFile(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      parameters.payload.file = fs.createReadStream(parameters.payload.file);
+      const openai = new OpenAI(this.clientParams);
+
+      parameters.msg.payload.file = fs.createReadStream(
+        parameters.msg.payload.file,
+      );
       const response = await openai.files.create({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async deleteFile(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
       const response = await openai.files.del({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async retrieveFile(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
-      const file_id = parameters.payload.file_id;
-      delete parameters.payload.file_id;
+      const file_id = parameters.msg.payload.file_id;
+      delete parameters.msg.payload.file_id;
 
       const response = await openai.files.retrieve(file_id, {
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async downloadFile(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
-      const file_id = parameters.payload.file_id;
-      delete parameters.payload.file_id;
+      const file_id = parameters.msg.payload.file_id;
+      delete parameters.msg.payload.file_id;
 
       const response = await openai.files.retrieveContent(file_id, {
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async createFineTuningJob(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
       const response = await openai.fineTuning.jobs.create({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async listPaginatedFineTuningJobs(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
       const list = await openai.fineTuning.jobs.list({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       let response = [];
@@ -267,268 +220,176 @@ let OpenaiApi = (function () {
 
       return response;
     }
+
     async retrieveFineTuningJob(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
       const response = await openai.fineTuning.jobs.retrieve(
-        parameters.payload.fine_tuning_job_id,
+        parameters.msg.payload.fine_tuning_job_id,
       );
 
       return response;
     }
+
     async listFineTuningEvents(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
       let response = [];
       const list = await openai.fineTuning.jobs.listEvents(
-        parameters.payload.fine_tuning_job_id,
+        parameters.msg.payload.fine_tuning_job_id,
       );
       for await (const fineTuneEvent of list) {
         response.push(fineTuneEvent);
       }
       return response;
     }
+
     async cancelFineTuningJob(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
       const response = await openai.fineTuning.jobs.cancel(
-        parameters.payload.fine_tuning_job_id,
+        parameters.msg.payload.fine_tuning_job_id,
       );
 
       return response;
     }
-    async listModels(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
+    async listModels(parameters) {
+      const openai = new OpenAI(this.clientParams);
       const response = await openai.models.list();
 
       return response.body;
     }
+
     async retrieveModel(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const model = parameters.payload.model;
+      const openai = new OpenAI(this.clientParams);
+      const model = parameters.msg.payload.model;
       const response = await openai.models.retrieve(model);
 
       return response;
     }
+
     async deleteModel(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const model = parameters.payload.model;
+      const openai = new OpenAI(this.clientParams);
+      const model = parameters.msg.payload.model;
       const response = await openai.models.del(model);
 
       return response;
     }
-    async createModeration(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
-      const response = await openai.moderations.create(parameters.payload);
+    async createModeration(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const response = await openai.moderations.create(parameters.msg.payload);
       return response;
     }
-    async listAssistants(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
+    async listAssistants(parameters) {
+      const openai = new OpenAI(this.clientParams);
       const response = await openai.beta.assistants.list({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response.body;
     }
-    async createAssistant(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
+    async createAssistant(parameters) {
+      const openai = new OpenAI(this.clientParams);
       const response = await openai.beta.assistants.create({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async getAssistant(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const id = parameters.payload.assistant_id;
+      const openai = new OpenAI(this.clientParams);
+      const id = parameters.msg.payload.assistant_id;
       const response = await openai.beta.assistants.retrieve(id);
 
       return response;
     }
-    async modifyAssistant(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
-      const id = parameters.payload.assistant_id;
-      delete parameters.payload.assistant_id;
+    async modifyAssistant(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const id = parameters.msg.payload.assistant_id;
+      delete parameters.msg.payload.assistant_id;
 
       const response = await openai.beta.assistants.update(id, {
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async deleteAssistant(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const id = parameters.payload.assistant_id;
+      const openai = new OpenAI(this.clientParams);
+      const id = parameters.msg.payload.assistant_id;
       const response = await openai.beta.assistants.del(id);
 
       return response;
     }
-    async createThread(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
+    async createThread(parameters) {
+      const openai = new OpenAI(this.clientParams);
       const response = await openai.beta.threads.create({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async getThread(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const id = parameters.payload.thread_id;
+      const openai = new OpenAI(this.clientParams);
+      const id = parameters.msg.payload.thread_id;
       const response = await openai.beta.threads.retrieve(id);
 
       return response;
     }
-    async modifyThread(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
-      const id = parameters.payload.thread_id;
-      delete parameters.payload.thread_id;
+    async modifyThread(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const id = parameters.msg.payload.thread_id;
+      delete parameters.msg.payload.thread_id;
 
       const response = await openai.beta.threads.update(id, {
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async deleteThread(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const id = parameters.payload.thread_id;
+      const openai = new OpenAI(this.clientParams);
+      const id = parameters.msg.payload.thread_id;
       const response = await openai.beta.threads.del(id);
 
       return response;
     }
+
     async listMessages(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const id = parameters.payload.thread_id;
+      const openai = new OpenAI(this.clientParams);
+      const id = parameters.msg.payload.thread_id;
       const response = await openai.beta.threads.messages.list(id);
 
       return response.body;
     }
-    async createMessage(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
-      const thread_id = parameters.payload.thread_id;
-      delete parameters.payload.thread_id;
+    async createMessage(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const thread_id = parameters.msg.payload.thread_id;
+      delete parameters.msg.payload.thread_id;
 
       const response = await openai.beta.threads.messages.create(thread_id, {
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
-    async getMessage(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
-      const thread_id = parameters.payload.thread_id;
-      const message_id = parameters.payload.message_id;
+    async getMessage(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const thread_id = parameters.msg.payload.thread_id;
+      const message_id = parameters.msg.payload.message_id;
 
       const response = await openai.beta.threads.messages.retrieve(
         thread_id,
@@ -537,89 +398,64 @@ let OpenaiApi = (function () {
 
       return response;
     }
+
     async modifyMessage(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const thread_id = parameters.payload.thread_id;
-      const message_id = parameters.payload.message_id;
-      delete parameters.payload.thread_id;
-      delete parameters.payload.message_id;
+      const openai = new OpenAI(this.clientParams);
+      const thread_id = parameters.msg.payload.thread_id;
+      const message_id = parameters.msg.payload.message_id;
+      delete parameters.msg.payload.thread_id;
+      delete parameters.msg.payload.message_id;
 
       const response = await openai.beta.threads.messages.update(
         thread_id,
         message_id,
         {
-          ...parameters.payload,
+          ...parameters.msg.payload,
         },
       );
 
       return response;
     }
-    async createThreadAndRun(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
+    async createThreadAndRun(parameters) {
+      const openai = new OpenAI(this.clientParams);
       const response = await openai.beta.threads.createAndRun({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
-    async listRuns(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
-      const thred_id = parameters.payload.thread_id;
-      delete parameters.payload.thread_id;
+    async listRuns(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const thred_id = parameters.msg.payload.thread_id;
+      delete parameters.msg.payload.thread_id;
 
       const response = await openai.beta.threads.runs.list(thred_id, {
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response.body;
     }
-    async createRun(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
-      const thread_id = parameters.payload.thread_id;
-      delete parameters.payload.thread_id;
+    async createRun(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const thread_id = parameters.msg.payload.thread_id;
+      delete parameters.msg.payload.thread_id;
 
       const response = await openai.beta.threads.runs.create(thread_id, {
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async getRun(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const thread_id = parameters.payload.thread_id;
-      const run_id = parameters.payload.run_id;
-      delete parameters.payload.thread_id;
-      delete parameters.payload.run_id;
+      const openai = new OpenAI(this.clientParams);
+      const thread_id = parameters.msg.payload.thread_id;
+      const run_id = parameters.msg.payload.run_id;
+      delete parameters.msg.payload.thread_id;
+      delete parameters.msg.payload.run_id;
 
       const response = await openai.beta.threads.runs.retrieve(
         thread_id,
@@ -628,109 +464,84 @@ let OpenaiApi = (function () {
 
       return response;
     }
+
     async modifyRun(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const thread_id = parameters.payload.thread_id;
-      const run_id = parameters.payload.run_id;
-      delete parameters.payload.thread_id;
-      delete parameters.payload.run_id;
+      const openai = new OpenAI(this.clientParams);
+      const thread_id = parameters.msg.payload.thread_id;
+      const run_id = parameters.msg.payload.run_id;
+      delete parameters.msg.payload.thread_id;
+      delete parameters.msg.payload.run_id;
 
       const response = await openai.beta.threads.runs.update(
         thread_id,
         run_id,
         {
-          ...parameters.payload,
+          ...parameters.msg.payload,
         },
       );
 
       return response;
     }
+
     async submitToolOuputsToRun(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const thread_id = parameters.payload.thread_id;
-      const run_id = parameters.payload.run_id;
-      delete parameters.payload.thread_id;
-      delete parameters.payload.run_id;
+      const openai = new OpenAI(this.clientParams);
+      const thread_id = parameters.msg.payload.thread_id;
+      const run_id = parameters.msg.payload.run_id;
+      delete parameters.msg.payload.thread_id;
+      delete parameters.msg.payload.run_id;
 
       const response = await openai.beta.threads.runs.submitToolOutputs(
         thread_id,
         run_id,
         {
-          ...parameters.payload,
+          ...parameters.msg.payload,
         },
       );
 
       return response;
     }
+
     async cancelRun(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const thread_id = parameters.payload.thread_id;
-      const run_id = parameters.payload.run_id;
-      delete parameters.payload.thread_id;
-      delete parameters.payload.run_id;
+      const openai = new OpenAI(this.clientParams);
+      const thread_id = parameters.msg.payload.thread_id;
+      const run_id = parameters.msg.payload.run_id;
+      delete parameters.msg.payload.thread_id;
+      delete parameters.msg.payload.run_id;
 
       const response = await openai.beta.threads.runs.cancel(
         thread_id,
         run_id,
         {
-          ...parameters.payload,
+          ...parameters.msg.payload,
         },
       );
 
       return response;
     }
+
     async listRunSteps(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const thread_id = parameters.payload.thread_id;
-      const run_id = parameters.payload.run_id;
-      delete parameters.payload.thread_id;
-      delete parameters.payload.run_id;
+      const openai = new OpenAI(this.clientParams);
+      const thread_id = parameters.msg.payload.thread_id;
+      const run_id = parameters.msg.payload.run_id;
+      delete parameters.msg.payload.thread_id;
+      delete parameters.msg.payload.run_id;
 
       const response = await openai.beta.threads.runs.steps.list(
         thread_id,
         run_id,
         {
-          ...parameters.payload,
+          ...parameters.msg.payload,
         },
       );
 
       return response.body;
     }
-    async getRunStep(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
-      const thread_id = parameters.payload.thread_id;
-      const run_id = parameters.payload.run_id;
-      const step_id = parameters.payload.step_id;
+    async getRunStep(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const thread_id = parameters.msg.payload.thread_id;
+      const run_id = parameters.msg.payload.run_id;
+      const step_id = parameters.msg.payload.step_id;
 
       const response = await openai.beta.threads.runs.steps.retrieve(
         thread_id,
@@ -740,131 +551,101 @@ let OpenaiApi = (function () {
 
       return response;
     }
-    async listAssistantFiles(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
-      const assistant_id = parameters.payload.assistant_id;
-      delete parameters.payload.assistant_id;
+    async listAssistantFiles(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const assistant_id = parameters.msg.payload.assistant_id;
+      delete parameters.msg.payload.assistant_id;
 
       const response = await openai.beta.assistants.files.list(assistant_id, {
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response.body;
     }
-    async createAssistantFile(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
-      const assistant_id = parameters.payload.assistant_id;
-      delete parameters.payload.assistant_id;
+    async createAssistantFile(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const assistant_id = parameters.msg.payload.assistant_id;
+      delete parameters.msg.payload.assistant_id;
 
       const response = await openai.beta.assistants.files.create(assistant_id, {
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async getAssistantFile(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const assistant_id = parameters.payload.assistant_id;
-      const file_id = parameters.payload.file_id;
-      delete parameters.payload.assistant_id;
-      delete parameters.payload.file_id;
+      const openai = new OpenAI(this.clientParams);
+      const assistant_id = parameters.msg.payload.assistant_id;
+      const file_id = parameters.msg.payload.file_id;
+      delete parameters.msg.payload.assistant_id;
+      delete parameters.msg.payload.file_id;
 
       const response = await openai.beta.assistants.files.retrieve(
         assistant_id,
         file_id,
         {
-          ...parameters.payload,
+          ...parameters.msg.payload,
         },
       );
 
       return response;
     }
+
     async deleteAssistantFile(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const assistant_id = parameters.payload.assistant_id;
-      const file_id = parameters.payload.file_id;
-      delete parameters.payload.assistant_id;
-      delete parameters.payload.file_id;
+      const openai = new OpenAI(this.clientParams);
+      const assistant_id = parameters.msg.payload.assistant_id;
+      const file_id = parameters.msg.payload.file_id;
+      delete parameters.msg.payload.assistant_id;
+      delete parameters.msg.payload.file_id;
 
       const response = await openai.beta.assistants.files.del(
         assistant_id,
         file_id,
         {
-          ...parameters.payload,
+          ...parameters.msg.payload,
         },
       );
 
       return response;
     }
+
     async listMessageFiles(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
-      const thread_id = parameters.payload.thread_id;
-      const message_id = parameters.payload.message_id;
-      delete parameters.payload.thread_id;
-      delete parameters.payload.message_id;
+      const openai = new OpenAI(this.clientParams);
+      const thread_id = parameters.msg.payload.thread_id;
+      const message_id = parameters.msg.payload.message_id;
+      delete parameters.msg.payload.thread_id;
+      delete parameters.msg.payload.message_id;
 
       const response = await openai.beta.threads.messages.files.list(
         thread_id,
         message_id,
         {
-          ...parameters.payload,
+          ...parameters.msg.payload,
         },
       );
 
       return response;
     }
-    async getMessageFile(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
 
-      const thread_id = parameters.payload.thread_id;
-      const message_id = parameters.payload.message_id;
-      const file_id = parameters.payload.file_id;
+    async getMessageFile(parameters) {
+      const openai = new OpenAI(this.clientParams);
+      const thread_id = parameters.msg.payload.thread_id;
+      const message_id = parameters.msg.payload.message_id;
+      const file_id = parameters.msg.payload.file_id;
 
-      delete parameters.payload.thread_id;
-      delete parameters.payload.message_id;
-      delete parameters.payload.file_id;
+      delete parameters.msg.payload.thread_id;
+      delete parameters.msg.payload.message_id;
+      delete parameters.msg.payload.file_id;
 
       const response = await openai.beta.threads.messages.files.retrieve(
         thread_id,
         message_id,
         file_id,
         {
-          ...parameters.payload,
+          ...parameters.msg.payload,
         },
       );
 

package/node.html

@@ -1,3 +1,5 @@
+<!--TODO: Implement Batch API endpoints: https://github.com/openai/openai-node/blob/6f72e7ad3e4e151c9334f4449d1c3555255c2793/CHANGELOG.md#features-2 -->
+
 <script type="text/javascript">
   RED.nodes.registerType("OpenAI API", {
     category: "AI",
@@ -34,7 +36,7 @@
       $("#node-input-property").typedInput({
         default: "msg",
         value: "payload",
-        types:["msg", "flow", "global"],
+        types: ["msg", "flow", "global"],
         typeField: "#node-input-propertyType"
       })
     }
@@ -852,6 +854,17 @@
         <span class="property-type">number</span>
       </dt>
       <dd>The sampling temperature, between 0 and 1.</dd>
+
+      <dt class="optional">
+        timestamp_granularities
+        <a
+          href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-timestamp_granularities"
+          target="_blank"
+          ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+        ></a>
+        <span class="property-type">array</span>
+      </dt>
+      <dd>The timestamp granularities to populate for this transcription. <code>response_format</code> must be set to <code>verbose_json</code> to use timestamp granularities. Either or both of these options are supported: <code>word</code>, or <code>segment</code>.</dd>
     </dl>
 
     <h2>Create Translation</h2>
@@ -1831,6 +1844,18 @@
         <span class="property-type">string</span>
       </dt>
       <dd>A cursor for use in pagination.</dd>
+
+      <dt class="optional">
+        run_id
+        <a
+          href="https://platform.openai.com/docs/api-reference/messages/listMessages#messages-listmessages-run_id"
+          target="_blank"
+          ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+        ></a>
+        <span class="property-type">string</span>
+      </dt>
+      <dd>Filter messages by the run ID that generated them.</dd>
+
     </dl>
 
     <h3>Create Message</h3>
@@ -2224,6 +2249,90 @@
           <span class="property-type">object</span>
         </dt>
         <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
+
+
+        <dt class="optional">
+          temperature
+          <a
+            href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-temperature"
+            target="_blank"
+            ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+          ></a>
+          <span class="property-type">number</span>
+        </dt>
+        <dd>What sampling temperature to use, between 0 and 2.</dd>
+        
+        <dt class="optional">
+          stream
+          <a
+            href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-stream"
+            target="_blank"
+            ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+          ></a>
+          <span class="property-type">boolean</span>
+        </dt>
+        <dd>If <code>true</code>, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a <code>data: [DONE]</code> message.</dd>
+        
+        <dt class="optional">
+          max_prompt_tokens
+          <a
+            href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-max_prompt_tokens"
+            target="_blank"
+            ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+          ></a>
+          <span class="property-type">integer</span>
+        </dt>
+        <dd>The maximum number of prompt tokens that may be used over the course of the run.</dd>
+        
+        <dt class="optional">
+          max_completion_tokens
+          <a
+            href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-max_completion_tokens"
+            target="_blank"
+            ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+          ></a>
+          <span class="property-type">integer</span>
+        </dt>
+        <dd>The maximum number of completion tokens that may be used over the course of the run.</dd>
+
+        <dt class="optional">
+          truncation_strategy
+          <a
+            href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-truncation_strategy"
+            target="_blank"
+            ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+          ></a>
+          <span class="property-type">object</span>
+          <dd>
+            <strong><code>@property {string} type</code></strong> - The truncation strategy to use for the thread. The default is <code>auto</code>. If set to <code>last_messages</code>, the thread will be truncated to the n most recent messages in the thread. When set to <code>auto</code>, messages in the middle of the thread will be dropped to fit the context length of the model, <code>max_prompt_tokens</code>.
+          </dd>
+          <dd>
+            <strong><code>@property {integer} [last_messages]</code></strong> - The number of most recent messages from the thread when constructing the context for the run.
+          </dd>
+        </dt>
+
+        <dt class="optional">
+          tool_choice
+          <a
+            href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-tool_choice"
+            target="_blank"
+            ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+          ></a>
+          <span class="property-type">string | object</span>
+        </dt>
+        <dd>Controls which (if any) tool is called by the model. <code>none</code> means the model will not call any tools and instead generates a message. <code>auto</code> is the default value and means the model can pick between generating a message or calling a tool. Specifying a particular tool like <code>{"type": "TOOL_TYPE"}</code> forces the model to call that tool.</dd>
+
+        <dt class="optional">
+          response_format
+          <a
+            href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-response_format"
+            target="_blank"
+            ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+          ></a>
+          <span class="property-type">string | object</span>
+        </dt>
+        <dd>Specifies the format that the model must output.</dd>
+
       </dl>
 
       <h2>List Runs</h2>
@@ -2328,9 +2437,35 @@
           <span class="property-type">string</span>
         </dt>
         <dd>
-          Appends additional instructions at the end of the instructions for the
-          run.
+          Overrides the instructions of the assistant. This is useful for modifying the behavior on a per-run basis.
         </dd>
+
+        <dt class="optional">
+          additional_instructions
+          <a
+            href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-additional_instructions"
+            target="_blank"
+            ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+          ></a>
+          <span class="property-type">string</span>
+        </dt>
+        <dd>
+          Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.
+        </dd>
+
+        <dt class="optional">
+          additional_messages
+          <a
+            href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-additional_messages"
+            target="_blank"
+            ><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
+          ></a>
+          <span class="property-type">array</span>
+        </dt>
+        <dd>
+          Adds additional messages to the thread before creating the run.
+        </dd>
+
         <dt class="optional">
           tools
           <a
@@ -2789,4 +2924,4 @@
 <script type="text/html" data-help-name="Service Host">
   <p><b>Header</b>: Variable name to set API key</p>
   <p><b>Value</b>: Value of API key</p>
-</script>
+</script>

package/node.js

@@ -11,7 +11,15 @@ module.exports = function (RED) {
       node.config = config;
 
       node.on("input", function (msg) {
-        let client = new lib.OpenaiApi();
+        let clientApiKey = node.service.credentials.secureApiKeyValue || "";
+        let clientApiBase = node.service.apiBase;
+        let clientOrganization = node.service.organizationId;
+
+        let client = new lib.OpenaiApi(
+          clientApiKey,
+          clientApiBase,
+          clientOrganization,
+        );
         let payload;
 
         const propertyType = node.config.propertyType || "msg";
@@ -26,11 +34,8 @@ module.exports = function (RED) {
 
         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: payload,
+          msg: msg,
         };
 
         // Dynamically call the function based on the service name

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inductiv/node-red-openai-api",
-  "version": "0.6.0",
+  "version": "0.8.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": {
@@ -27,7 +27,7 @@
     "ai"
   ],
   "dependencies": {
-    "openai": "^4.26.1"
+    "openai": "^4.36.0"
   },
   "devDependencies": {
     "eslint": "^8.54.0",