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

package/README.md

@@ -9,9 +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.7.0
+## New in Version 0.8.0
 
-- The ```createChatCompletion``` endpoint now retains top-level message (```msg```) properties in responses. This means that all custom message properties--aside from the `msg.payload` object--are returned from ```createChatCompletion``` requests.
+- **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).
 
@@ -53,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,17 +5,19 @@ 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.msg.payload,
       });
@@ -28,9 +30,11 @@ let OpenaiApi = (function () {
         });
         for await (const chunk of response) {
           if (typeof chunk === "object") {
-            let msg = parameters.msg;
-            msg.payload = chunk;
-            node.send(msg);
+            
+            let {_msgid, ...newMsg} = parameters.msg;
+            newMsg.payload = chunk;
+
+            node.send(newMsg);
           }
         }
         node.status({});
@@ -40,13 +44,7 @@ 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.msg.payload,
       });
@@ -55,12 +53,7 @@ let OpenaiApi = (function () {
     }
 
     async createImageEdit(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
       parameters.msg.payload.image = fs.createReadStream(
         parameters.msg.payload.image,
@@ -79,12 +72,7 @@ let OpenaiApi = (function () {
     }
 
     async createImageVariation(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
       parameters.msg.payload.image = fs.createReadStream(
         parameters.msg.payload.image,
@@ -97,12 +85,7 @@ let OpenaiApi = (function () {
     }
 
     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.msg.payload,
@@ -112,12 +95,7 @@ let OpenaiApi = (function () {
     }
 
     async createSpeech(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
       const audio = await openai.audio.speech.create({
         ...parameters.msg.payload,
@@ -128,12 +106,7 @@ let OpenaiApi = (function () {
     }
 
     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.msg.payload.file = fs.createReadStream(
         parameters.msg.payload.file,
@@ -147,12 +120,7 @@ let OpenaiApi = (function () {
     }
 
     async createTranslation(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
       parameters.msg.payload.file = fs.createReadStream(
         parameters.msg.payload.file,
@@ -165,12 +133,7 @@ let OpenaiApi = (function () {
     }
 
     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.msg.payload,
@@ -185,12 +148,7 @@ let OpenaiApi = (function () {
     }
 
     async createFile(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
+      const openai = new OpenAI(this.clientParams);
 
       parameters.msg.payload.file = fs.createReadStream(
         parameters.msg.payload.file,
@@ -203,12 +161,7 @@ let OpenaiApi = (function () {
     }
 
     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.msg.payload,
@@ -218,12 +171,7 @@ let OpenaiApi = (function () {
     }
 
     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.msg.payload.file_id;
       delete parameters.msg.payload.file_id;
@@ -236,12 +184,7 @@ let OpenaiApi = (function () {
     }
 
     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.msg.payload.file_id;
       delete parameters.msg.payload.file_id;
@@ -254,12 +197,7 @@ let OpenaiApi = (function () {
     }
 
     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.msg.payload,
@@ -269,12 +207,7 @@ let OpenaiApi = (function () {
     }
 
     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.msg.payload,
@@ -289,12 +222,7 @@ let OpenaiApi = (function () {
     }
 
     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.msg.payload.fine_tuning_job_id,
@@ -304,12 +232,7 @@ let OpenaiApi = (function () {
     }
 
     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(
@@ -322,12 +245,7 @@ let OpenaiApi = (function () {
     }
 
     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.msg.payload.fine_tuning_job_id,
@@ -337,26 +255,14 @@ let OpenaiApi = (function () {
     }
 
     async listModels(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.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 openai = new OpenAI(this.clientParams);
       const model = parameters.msg.payload.model;
       const response = await openai.models.retrieve(model);
 
@@ -364,13 +270,7 @@ let OpenaiApi = (function () {
     }
 
     async deleteModel(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      const openai = new OpenAI(this.clientParams);
       const model = parameters.msg.payload.model;
       const response = await openai.models.del(model);
 
@@ -378,25 +278,13 @@ let OpenaiApi = (function () {
     }
 
     async createModeration(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.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);
-
+      const openai = new OpenAI(this.clientParams);
       const response = await openai.beta.assistants.list({
         ...parameters.msg.payload,
       });
@@ -405,13 +293,7 @@ let OpenaiApi = (function () {
     }
 
     async createAssistant(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.beta.assistants.create({
         ...parameters.msg.payload,
       });
@@ -420,13 +302,7 @@ let OpenaiApi = (function () {
     }
 
     async getAssistant(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      const openai = new OpenAI(this.clientParams);
       const id = parameters.msg.payload.assistant_id;
       const response = await openai.beta.assistants.retrieve(id);
 
@@ -434,13 +310,7 @@ let OpenaiApi = (function () {
     }
 
     async modifyAssistant(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      const openai = new OpenAI(this.clientParams);
       const id = parameters.msg.payload.assistant_id;
       delete parameters.msg.payload.assistant_id;
 
@@ -452,13 +322,7 @@ let OpenaiApi = (function () {
     }
 
     async deleteAssistant(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      const openai = new OpenAI(this.clientParams);
       const id = parameters.msg.payload.assistant_id;
       const response = await openai.beta.assistants.del(id);
 
@@ -466,13 +330,7 @@ let OpenaiApi = (function () {
     }
 
     async createThread(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.beta.threads.create({
         ...parameters.msg.payload,
       });
@@ -481,13 +339,7 @@ let OpenaiApi = (function () {
     }
 
     async getThread(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      const openai = new OpenAI(this.clientParams);
       const id = parameters.msg.payload.thread_id;
       const response = await openai.beta.threads.retrieve(id);
 
@@ -495,13 +347,7 @@ let OpenaiApi = (function () {
     }
 
     async modifyThread(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      const openai = new OpenAI(this.clientParams);
       const id = parameters.msg.payload.thread_id;
       delete parameters.msg.payload.thread_id;
 
@@ -513,13 +359,7 @@ let OpenaiApi = (function () {
     }
 
     async deleteThread(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      const openai = new OpenAI(this.clientParams);
       const id = parameters.msg.payload.thread_id;
       const response = await openai.beta.threads.del(id);
 
@@ -527,13 +367,7 @@ let OpenaiApi = (function () {
     }
 
     async listMessages(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      const openai = new OpenAI(this.clientParams);
       const id = parameters.msg.payload.thread_id;
       const response = await openai.beta.threads.messages.list(id);
 
@@ -541,13 +375,7 @@ let OpenaiApi = (function () {
     }
 
     async createMessage(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      const openai = new OpenAI(this.clientParams);
       const thread_id = parameters.msg.payload.thread_id;
       delete parameters.msg.payload.thread_id;
 
@@ -559,13 +387,7 @@ let OpenaiApi = (function () {
     }
 
     async getMessage(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      const openai = new OpenAI(this.clientParams);
       const thread_id = parameters.msg.payload.thread_id;
       const message_id = parameters.msg.payload.message_id;
 
@@ -578,13 +400,7 @@ let OpenaiApi = (function () {
     }
 
     async modifyMessage(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      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;
@@ -602,13 +418,7 @@ let OpenaiApi = (function () {
     }
 
     async createThreadAndRun(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.beta.threads.createAndRun({
         ...parameters.msg.payload,
       });
@@ -617,13 +427,7 @@ let OpenaiApi = (function () {
     }
 
     async listRuns(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      const openai = new OpenAI(this.clientParams);
       const thred_id = parameters.msg.payload.thread_id;
       delete parameters.msg.payload.thread_id;
 
@@ -635,13 +439,7 @@ let OpenaiApi = (function () {
     }
 
     async createRun(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      const openai = new OpenAI(this.clientParams);
       const thread_id = parameters.msg.payload.thread_id;
       delete parameters.msg.payload.thread_id;
 
@@ -653,13 +451,7 @@ let OpenaiApi = (function () {
     }
 
     async getRun(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      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;
@@ -674,13 +466,7 @@ let OpenaiApi = (function () {
     }
 
     async modifyRun(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      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;
@@ -698,13 +484,7 @@ let OpenaiApi = (function () {
     }
 
     async submitToolOuputsToRun(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      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;
@@ -722,13 +502,7 @@ let OpenaiApi = (function () {
     }
 
     async cancelRun(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      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;
@@ -746,13 +520,7 @@ let OpenaiApi = (function () {
     }
 
     async listRunSteps(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      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;
@@ -770,13 +538,7 @@ let OpenaiApi = (function () {
     }
 
     async getRunStep(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      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;
@@ -791,13 +553,7 @@ let OpenaiApi = (function () {
     }
 
     async listAssistantFiles(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      const openai = new OpenAI(this.clientParams);
       const assistant_id = parameters.msg.payload.assistant_id;
       delete parameters.msg.payload.assistant_id;
 
@@ -809,13 +565,7 @@ let OpenaiApi = (function () {
     }
 
     async createAssistantFile(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      const openai = new OpenAI(this.clientParams);
       const assistant_id = parameters.msg.payload.assistant_id;
       delete parameters.msg.payload.assistant_id;
 
@@ -827,13 +577,7 @@ let OpenaiApi = (function () {
     }
 
     async getAssistantFile(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      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;
@@ -851,13 +595,7 @@ let OpenaiApi = (function () {
     }
 
     async deleteAssistantFile(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      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;
@@ -875,13 +613,7 @@ let OpenaiApi = (function () {
     }
 
     async listMessageFiles(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      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;
@@ -899,13 +631,7 @@ let OpenaiApi = (function () {
     }
 
     async getMessageFile(parameters) {
-      const clientParams = {
-        apiKey: parameters.apiKey,
-        baseURL: parameters.apiBase,
-        organization: parameters.organization,
-      };
-      const openai = new OpenAI(clientParams);
-
+      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;

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,9 +34,6 @@ 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,
           msg: msg,
         };

package/package.json

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