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

package/README.md

@@ -9,11 +9,11 @@
 
 _@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.5.0
+## New in Version 0.7.0
 
-- Chat completion streaming responses are now returned in the `msg.payload` object, consistent with other
-endpont response structures.
-- Bug fixes.
+- 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.
+
+Please report any issues [here on Github](https://github.com/allanbunch/node-red-openai-api/issues).
 
 ## Key Features
 
@@ -92,21 +92,15 @@ I very much appreciate community input and invite everyone to shape the future o
 
 ### Engage in Various Discussions
 
-- **Announcements**: Stay updated with the latest project news.
-- **General**: Share thoughts or seek advice on broader topics.
-- **Ideas**: Propose new features or improvements.
-- **Polls**: Participate in polls to influence project decisions.
-- **Q&A**: Get answers to your questions and share your expertise.
-- **Show and Tell**: Showcase your creative implementations and inspire others.
+- **[Announcements](https://github.com/allanbunch/node-red-openai-api/discussions/categories/announcements)**: Stay updated with the latest project news.
+- **[General](https://github.com/allanbunch/node-red-openai-api/discussions/categories/general)**: Share thoughts or seek advice on broader topics.
+- **[Ideas](https://github.com/allanbunch/node-red-openai-api/discussions/categories/ideas)**: Propose new features or improvements.
+- **[Polls](https://github.com/allanbunch/node-red-openai-api/discussions/categories/polls)**: Participate in polls to influence project decisions.
+- **[Q&A](https://github.com/allanbunch/node-red-openai-api/discussions/categories/q-a)**: Get answers to your questions and share your expertise.
+- **[Show and Tell](https://github.com/allanbunch/node-red-openai-api/discussions/categories/show-and-tell)**: Showcase your creative implementations and inspire others.
 
 Join the conversation [here](https://github.com/allanbunch/node-red-openai-api/discussions) and let's build a vibrant and collaborative community together!
 
 ## License
 
 [MIT](./LICENSE)
-
-## Acknowledgements
-
-- [node-red-nodegen](https://github.com/node-red/node-red-nodegen)
-  - For boilerplate code generation, though the auto-generated code has been largely refactored.
-  - **Note:** This package uses `axios` in place of node-red-nodegen's `request` default.

package/lib.js

@@ -17,10 +17,10 @@ let OpenaiApi = (function () {
 
       const openai = new OpenAI(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 +28,9 @@ let OpenaiApi = (function () {
         });
         for await (const chunk of response) {
           if (typeof chunk === "object") {
-            let payload = { payload: chunk };
-            node.send(payload);
+            let msg = parameters.msg;
+            msg.payload = chunk;
+            node.send(msg);
           }
         }
         node.status({});
@@ -47,7 +48,7 @@ let OpenaiApi = (function () {
 
       const openai = new OpenAI(clientParams);
       const response = await openai.images.generate({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
@@ -61,13 +62,17 @@ let OpenaiApi = (function () {
       };
       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);
+      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;
@@ -81,9 +86,11 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      parameters.payload.image = fs.createReadStream(parameters.payload.image);
+      parameters.msg.payload.image = fs.createReadStream(
+        parameters.msg.payload.image,
+      );
       const response = await openai.images.createVariation({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
@@ -98,7 +105,7 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(clientParams);
 
       const response = await openai.embeddings.create({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
@@ -112,7 +119,9 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const audio = await openai.audio.speech.create({ ...parameters.payload });
+      const audio = await openai.audio.speech.create({
+        ...parameters.msg.payload,
+      });
       const response = Buffer.from(await audio.arrayBuffer());
 
       return response;
@@ -126,10 +135,12 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(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;
@@ -143,9 +154,11 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      parameters.payload.file = fs.createReadStream(parameters.payload.file);
+      parameters.msg.payload.file = fs.createReadStream(
+        parameters.msg.payload.file,
+      );
       const response = await openai.audio.translations.create({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
@@ -160,7 +173,7 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(clientParams);
 
       const list = await openai.files.list({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       let files = [];
@@ -179,13 +192,16 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      parameters.payload.file = fs.createReadStream(parameters.payload.file);
+      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,
@@ -195,11 +211,12 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(clientParams);
 
       const response = await openai.files.del({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async retrieveFile(parameters) {
       const clientParams = {
         apiKey: parameters.apiKey,
@@ -208,15 +225,16 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(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,
@@ -225,15 +243,16 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(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,
@@ -243,11 +262,12 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(clientParams);
 
       const response = await openai.fineTuning.jobs.create({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async listPaginatedFineTuningJobs(parameters) {
       const clientParams = {
         apiKey: parameters.apiKey,
@@ -257,7 +277,7 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(clientParams);
 
       const list = await openai.fineTuning.jobs.list({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       let response = [];
@@ -267,6 +287,7 @@ let OpenaiApi = (function () {
 
       return response;
     }
+
     async retrieveFineTuningJob(parameters) {
       const clientParams = {
         apiKey: parameters.apiKey,
@@ -276,11 +297,12 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(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,
@@ -291,13 +313,14 @@ let OpenaiApi = (function () {
 
       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,
@@ -307,11 +330,12 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(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,
@@ -324,6 +348,7 @@ let OpenaiApi = (function () {
 
       return response.body;
     }
+
     async retrieveModel(parameters) {
       const clientParams = {
         apiKey: parameters.apiKey,
@@ -332,11 +357,12 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const model = parameters.payload.model;
+      const model = parameters.msg.payload.model;
       const response = await openai.models.retrieve(model);
 
       return response;
     }
+
     async deleteModel(parameters) {
       const clientParams = {
         apiKey: parameters.apiKey,
@@ -345,11 +371,12 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const model = parameters.payload.model;
+      const model = parameters.msg.payload.model;
       const response = await openai.models.del(model);
 
       return response;
     }
+
     async createModeration(parameters) {
       const clientParams = {
         apiKey: parameters.apiKey,
@@ -358,9 +385,10 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const response = await openai.moderations.create(parameters.payload);
+      const response = await openai.moderations.create(parameters.msg.payload);
       return response;
     }
+
     async listAssistants(parameters) {
       const clientParams = {
         apiKey: parameters.apiKey,
@@ -370,11 +398,12 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(clientParams);
 
       const response = await openai.beta.assistants.list({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response.body;
     }
+
     async createAssistant(parameters) {
       const clientParams = {
         apiKey: parameters.apiKey,
@@ -384,11 +413,12 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(clientParams);
 
       const response = await openai.beta.assistants.create({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async getAssistant(parameters) {
       const clientParams = {
         apiKey: parameters.apiKey,
@@ -397,11 +427,12 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const id = parameters.payload.assistant_id;
+      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,
@@ -410,15 +441,16 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const id = parameters.payload.assistant_id;
-      delete parameters.payload.assistant_id;
+      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,
@@ -427,11 +459,12 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const id = parameters.payload.assistant_id;
+      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,
@@ -441,11 +474,12 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(clientParams);
 
       const response = await openai.beta.threads.create({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async getThread(parameters) {
       const clientParams = {
         apiKey: parameters.apiKey,
@@ -454,11 +488,12 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const id = parameters.payload.thread_id;
+      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,
@@ -467,15 +502,16 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const id = parameters.payload.thread_id;
-      delete parameters.payload.thread_id;
+      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,
@@ -484,11 +520,12 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const id = parameters.payload.thread_id;
+      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,
@@ -497,11 +534,12 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const id = parameters.payload.thread_id;
+      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,
@@ -510,15 +548,16 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const thread_id = parameters.payload.thread_id;
-      delete parameters.payload.thread_id;
+      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,
@@ -527,8 +566,8 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const thread_id = parameters.payload.thread_id;
-      const message_id = parameters.payload.message_id;
+      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,6 +576,7 @@ let OpenaiApi = (function () {
 
       return response;
     }
+
     async modifyMessage(parameters) {
       const clientParams = {
         apiKey: parameters.apiKey,
@@ -545,21 +585,22 @@ let OpenaiApi = (function () {
       };
       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 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,
@@ -569,11 +610,12 @@ let OpenaiApi = (function () {
       const openai = new OpenAI(clientParams);
 
       const response = await openai.beta.threads.createAndRun({
-        ...parameters.payload,
+        ...parameters.msg.payload,
       });
 
       return response;
     }
+
     async listRuns(parameters) {
       const clientParams = {
         apiKey: parameters.apiKey,
@@ -582,15 +624,16 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const thred_id = parameters.payload.thread_id;
-      delete parameters.payload.thread_id;
+      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,
@@ -599,15 +642,16 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const thread_id = parameters.payload.thread_id;
-      delete parameters.payload.thread_id;
+      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,
@@ -616,10 +660,10 @@ let OpenaiApi = (function () {
       };
       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 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,6 +672,7 @@ let OpenaiApi = (function () {
 
       return response;
     }
+
     async modifyRun(parameters) {
       const clientParams = {
         apiKey: parameters.apiKey,
@@ -636,21 +681,22 @@ let OpenaiApi = (function () {
       };
       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 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,
@@ -659,21 +705,22 @@ let OpenaiApi = (function () {
       };
       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 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,
@@ -682,21 +729,22 @@ let OpenaiApi = (function () {
       };
       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 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,
@@ -705,21 +753,22 @@ let OpenaiApi = (function () {
       };
       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 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,
@@ -728,9 +777,9 @@ let OpenaiApi = (function () {
       };
       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;
+      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,6 +789,7 @@ let OpenaiApi = (function () {
 
       return response;
     }
+
     async listAssistantFiles(parameters) {
       const clientParams = {
         apiKey: parameters.apiKey,
@@ -748,15 +798,16 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const assistant_id = parameters.payload.assistant_id;
-      delete parameters.payload.assistant_id;
+      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,
@@ -765,15 +816,16 @@ let OpenaiApi = (function () {
       };
       const openai = new OpenAI(clientParams);
 
-      const assistant_id = parameters.payload.assistant_id;
-      delete parameters.payload.assistant_id;
+      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,
@@ -782,21 +834,22 @@ let OpenaiApi = (function () {
       };
       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 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,
@@ -805,21 +858,22 @@ let OpenaiApi = (function () {
       };
       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 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,
@@ -828,21 +882,22 @@ let OpenaiApi = (function () {
       };
       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 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,
@@ -851,20 +906,20 @@ let OpenaiApi = (function () {
       };
       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;
+      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/locales/en-US/node.json

@@ -8,7 +8,8 @@
             "header": "Auth Header",
             "organizationId": "Org Id",
             "apiKey": "API Key",
-            "isQuery": "isQuery"
+            "isQuery": "isQuery",
+            "property": "Property"
         },
         "status": {
             "requesting": "requesting",

package/node.html

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

package/node.js

@@ -5,21 +5,32 @@ module.exports = function (RED) {
   class OpenaiApiNode {
     constructor(config) {
       RED.nodes.createNode(this, config);
-      this.service = RED.nodes.getNode(config.service);
-      this.method = config.method;
 
       let node = this;
+      node.service = RED.nodes.getNode(config.service);
+      node.config = config;
 
       node.on("input", function (msg) {
         let client = new lib.OpenaiApi();
+        let payload;
 
-        const serviceName = node.method; // Set the service name to call.
+        const propertyType = node.config.propertyType || "msg";
+        const propertyPath = node.config.property || "payload";
+
+        if (propertyType === "msg") {
+          payload = RED.util.getMessageProperty(msg, propertyPath);
+        } else {
+          // For flow and global contexts
+          payload = node.context()[propertyType].get(propertyPath);
+        }
+
+        const serviceName = node.config.method; // Set the service name to call.
         let serviceParametersObject = {
           organization: node.service.organizationId,
           apiBase: node.service.apiBase,
           apiKey: node.service.credentials.secureApiKeyValue || "",
           _node: node,
-          payload: { ...msg.payload },
+          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.5.0",
+  "version": "0.7.0",
   "description": "Go beyond ChatGPT and DALL·E 3: this Node-RED node seamlessly integrates a range of OpenAI services, including Assistants, Threads, Vision, and Audio, enabling feature-rich enhancement of your AI workflows with any OpenAI REST API-compatible solution.",
   "main": "node.js",
   "engines": {

package/.eslintrc.json

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

package/.prettierrc

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