@inductiv/node-red-openai-api 1.89.0 → 1.103.0

package/src/runs/methods.js

@@ -0,0 +1,157 @@
+const OpenAI = require("openai").OpenAI;
+
+async function createThreadAndRun(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { _node, ...params } = parameters;
+  const response = await openai.beta.threads.createAndRun(params.payload);
+
+  if (params.payload.stream) {
+    _node.status({
+      fill: "green",
+      shape: "dot",
+      text: "OpenaiApi.status.streaming",
+    });
+    for await (const chunk of response) {
+      if (typeof chunk === "object") {
+        const newMsg = { ...parameters.msg, payload: chunk.data };
+        _node.send(newMsg);
+      }
+    }
+    _node.status({});
+  } else {
+    return response;
+  }
+}
+
+async function listRuns(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { thread_id, ...params } = parameters.payload;
+  const list = await openai.beta.threads.runs.list(thread_id, params);
+
+  return [...list.data];
+}
+
+async function createRun(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { _node, ..._params } = parameters;
+  const { thread_id, ...params } = _params.payload;
+  const response = await openai.beta.threads.runs.create(thread_id, params);
+
+  if (params.stream) {
+    _node.status({
+      fill: "green",
+      shape: "dot",
+      text: "OpenaiApi.status.streaming",
+    });
+    for await (const chunk of response) {
+      if (typeof chunk === "object") {
+        const newMsg = { ...parameters.msg, payload: chunk.data };
+        _node.send(newMsg);
+      }
+    }
+    _node.status({});
+  } else {
+    return response;
+  }
+}
+
+async function getRun(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { thread_id, run_id, ...params } = parameters.payload;
+  const response = await openai.beta.threads.runs.retrieve(
+    thread_id,
+    run_id,
+    params
+  );
+
+  return response;
+}
+
+async function modifyRun(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { thread_id, run_id, ...params } = parameters.payload;
+  const response = await openai.beta.threads.runs.update(
+    thread_id,
+    run_id,
+    params
+  );
+
+  return response;
+}
+
+async function submitToolOutputsToRun(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { _node, ..._params } = parameters;
+  const { thread_id, run_id, ...params } = _params.payload;
+  const response = await openai.beta.threads.runs.submitToolOutputs(
+    thread_id,
+    run_id,
+    params
+  );
+
+  if (params.stream) {
+    _node.status({
+      fill: "green",
+      shape: "dot",
+      text: "OpenaiApi.status.streaming",
+    });
+    for await (const chunk of response) {
+      if (typeof chunk === "object") {
+        const newMsg = { ...parameters.msg, payload: chunk.data };
+        _node.send(newMsg);
+      }
+    }
+    _node.status({});
+  } else {
+    return response;
+  }
+}
+
+async function cancelRun(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { thread_id, run_id, ...params } = parameters.payload;
+  const response = await openai.beta.threads.runs.cancel(
+    thread_id,
+    run_id,
+    params
+  );
+
+  return response;
+}
+
+async function listRunSteps(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { thread_id, run_id, ...params } = parameters.payload;
+  const list = await openai.beta.threads.runs.steps.list(
+    thread_id,
+    run_id,
+    params
+  );
+
+  return [...list.data];
+}
+
+async function getRunStep(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { thread_id, run_id, step_id, ...params } = parameters.payload;
+  const response = await openai.beta.threads.runs.steps.retrieve(
+    thread_id,
+    run_id,
+    step_id,
+    params
+  );
+
+  return response;
+}
+
+module.exports = {
+  createThreadAndRun,
+  listRuns,
+  createRun,
+  getRun,
+  modifyRun,
+  submitToolOutputsToRun,
+  cancelRun,
+  listRunSteps,
+  getRunStep,
+};

package/src/runs/template.html

@@ -0,0 +1,35 @@
+      <optgroup style="font-style: normal;" label="🔄 Runs (Beta)">
+        <option
+          value="createThreadAndRun"
+          data-i18n="OpenaiApi.parameters.createThreadAndRun"
+        ></option>
+        <option
+          value="listRuns"
+          data-i18n="OpenaiApi.parameters.listRuns"
+        ></option>
+        <option
+          value="createRun"
+          data-i18n="OpenaiApi.parameters.createRun"
+        ></option>
+        <option value="getRun" data-i18n="OpenaiApi.parameters.getRun"></option>
+        <option
+          value="modifyRun"
+          data-i18n="OpenaiApi.parameters.modifyRun"
+        ></option>
+        <option
+          value="submitToolOutputsToRun"
+          data-i18n="OpenaiApi.parameters.submitToolOutputsToRun"
+        ></option>
+        <option
+          value="cancelRun"
+          data-i18n="OpenaiApi.parameters.cancelRun"
+        ></option>
+        <option
+          value="listRunSteps"
+          data-i18n="OpenaiApi.parameters.listRunSteps"
+        ></option>
+        <option
+          value="getRunStep"
+          data-i18n="OpenaiApi.parameters.getRunStep"
+        ></option>
+      </optgroup>

package/src/threads/help.html

@@ -0,0 +1,88 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">🧵 Threads</summary>
+        <a href="https://platform.openai.com/docs/api-reference/threads" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+        <h4 style="font-weight: bolder;"> ⋙ Create Thread</h4>
+        <p>Create a thread.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt class="optional">
+                messages
+                <a href="https://platform.openai.com/docs/api-reference/threads/createThread#threads-createthread-messages"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">array</span>
+            </dt>
+            <dd>A list of messages to start the thread with.</dd>
+
+            <dt class="optional">
+                tool_resources
+                <a href="https://platform.openai.com/docs/api-reference/threads/createThread#threads-createthread-tool_resources"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">array</span>
+            </dt>
+            <dd>A set of resources that are made available to the assistant's tools in this thread.</dd>
+
+            <dt class="optional">
+                metadata
+                <a href="https://platform.openai.com/docs/api-reference/threads/createThread#threads-createthread-metadata"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Thread</h4>
+        <p>Retrieves a thread.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                thread_id
+                <a href="https://platform.openai.com/docs/api-reference/threads/getThread#threads-getthread-thread_id"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The ID of the thread to retrieve.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Modify Thread</h4>
+        <p>Modifies a thread.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                thread_id
+                <a href="https://platform.openai.com/docs/api-reference/threads/modifyThread#threads-modifythread-thread_id"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                The ID of the thread to modify. Only the metadata can be modified.
+            </dd>
+            <dt class="optional">
+                metadata
+                <a href="https://platform.openai.com/docs/api-reference/threads/modifyThread#threads-modifythread-metadata"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Set of 16 key-value pairs that can be attached to an object.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Delete Thread</h4>
+        <p>Delete a thread.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                thread_id
+                <a href="https://platform.openai.com/docs/api-reference/threads/deleteThread#threads-deletethread-thread_id"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The ID of the thread to delete.</dd>
+        </dl>
+
+    </details>
+</section>

package/src/threads/methods.js

@@ -0,0 +1,39 @@
+const OpenAI = require("openai").OpenAI;
+
+async function createThread(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const response = await openai.beta.threads.create(parameters.payload);
+
+  return response;
+}
+
+async function getThread(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { thread_id, ...params } = parameters.payload;
+  const response = await openai.beta.threads.retrieve(thread_id, params);
+
+  return response;
+}
+
+async function modifyThread(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { thread_id, ...params } = parameters.payload;
+  const response = await openai.beta.threads.update(thread_id, params);
+
+  return response;
+}
+
+async function deleteThread(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { thread_id, ...params } = parameters.payload;
+  const response = await openai.beta.threads.del(thread_id, params);
+
+  return response;
+}
+
+module.exports = {
+  createThread,
+  getThread,
+  modifyThread,
+  deleteThread,
+};

package/src/threads/template.html

@@ -0,0 +1,18 @@
+      <optgroup style="font-style: normal;" label="🧵 Threads (Beta)">
+        <option
+          value="createThread"
+          data-i18n="OpenaiApi.parameters.createThread"
+        ></option>
+        <option
+          value="getThread"
+          data-i18n="OpenaiApi.parameters.getThread"
+        ></option>
+        <option
+          value="modifyThread"
+          data-i18n="OpenaiApi.parameters.modifyThread"
+        ></option>
+        <option
+          value="deleteThread"
+          data-i18n="OpenaiApi.parameters.deleteThread"
+        ></option>
+      </optgroup>

package/src/uploads/help.html

@@ -0,0 +1,116 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">☁️ Uploads</summary>
+        <a href="https://platform.openai.com/docs/api-reference/uploads" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+        <h4 style="font-weight: bolder;"> ⋙ Create Upload</h4>
+        <p>Creates an intermediate Upload object that you can add Parts to. </p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                filename
+                <a href="https://platform.openai.com/docs/api-reference/uploads/create#uploads-create-filename"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The name of the file to upload.</dd>
+
+            <dt>
+                purpose
+                <a href="https://platform.openai.com/docs/api-reference/uploads/create#uploads-create-purpose"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The intended purpose of the uploaded file.</dd>
+
+            <dt>
+                bytes
+                <a href="https://platform.openai.com/docs/api-reference/uploads/create#uploads-create-bytes"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>The number of bytes in the file you are uploading.</dd>
+
+            <dt>
+                mime_type
+                <a href="https://platform.openai.com/docs/api-reference/uploads/create#uploads-create-mime_type"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>This must fall within the supported MIME types for your file purpose.</dd>
+
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Add Upload Part</h4>
+        <p>Adds a Part to an Upload object.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                upload_id
+                <a href="https://platform.openai.com/docs/api-reference/uploads/add-part#uploads-add-part-upload_id"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The ID of the Upload.</dd>
+
+            <dt>
+                data
+                <a href="https://platform.openai.com/docs/api-reference/uploads/add-part#uploads-add-part-data"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">file</span>
+            </dt>
+            <dd>The chunk of bytes for this Part.</dd>
+
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Complete Upload</h4>
+        <p>Completes the Upload.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                upload_id
+                <a href="https://platform.openai.com/docs/api-reference/uploads/complete#uploads-complete-upload_id"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                The ID of the Upload.
+            </dd>
+
+            <dt>
+                part_ids
+                <a href="https://platform.openai.com/docs/api-reference/uploads/complete#uploads-complete-part_ids"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">array</span>
+            </dt>
+            <dd>The ordered list of Part IDs.</dd>
+
+            <dt>
+                md5
+                <a href="https://platform.openai.com/docs/api-reference/uploads/complete#uploads-complete-md5"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The optional md5 checksum for the file contents.</dd>
+
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Cancel Upload</h4>
+        <p>Cancels the Upload.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                upload_id
+                <a href="https://platform.openai.com/docs/api-reference/uploads/cancel#uploads-cancel-upload_id"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The ID of the Upload.</dd>
+        </dl>
+
+    </details>
+</section>

package/src/uploads/methods.js

@@ -0,0 +1,121 @@
+const OpenAI = require("openai").OpenAI;
+
+async function createUpload(parameters) {
+  const openai = new OpenAI(this.clientParams);
+
+  // Define required parameters
+  const required_params = ["filename", "purpose", "bytes", "mime_type"];
+
+  // Validate that all required parameters are present
+  const missing_params = required_params.filter(
+    (param) => !parameters.payload?.[param]
+  );
+  if (missing_params.length > 0) {
+    throw new Error(
+      `Missing required parameter(s): ${missing_params.join(", ")}`
+    );
+  }
+
+  // Destructure and assign the payload to match SDK expectations
+  const { filename, purpose, bytes, mime_type, ...optionalParams } =
+    parameters.payload;
+
+  const response = await openai.uploads.create(
+    {
+      filename,
+      purpose,
+      bytes,
+      mime_type,
+    },
+    { ...optionalParams }
+  );
+
+  return response;
+}
+
+async function addUploadPart(parameters) {
+  const clientParams = {
+    ...this.clientParams,
+  };
+
+  const openai = new OpenAI(clientParams);
+
+  // Validate required parameters
+  const required_params = ["upload_id", "data"];
+  const missing_params = required_params.filter(
+    (param) => !parameters.payload?.[param]
+  );
+  if (missing_params.length > 0) {
+    throw new Error(
+      `Missing required parameter(s): ${missing_params.join(", ")}`
+    );
+  }
+
+  const { upload_id, data, ...optionalParams } = parameters.payload;
+  const response = await openai.uploads.parts.create(upload_id, data, {
+    ...optionalParams,
+  });
+
+  return response;
+}
+
+async function completeUpload(parameters) {
+  const clientParams = {
+    ...this.clientParams,
+  };
+
+  const openai = new OpenAI(clientParams);
+
+  // Validate required parameters
+  const required_params = ["upload_id", "part_ids"];
+  const missing_params = required_params.filter(
+    (param) => !parameters.payload?.[param]
+  );
+  if (missing_params.length > 0) {
+    throw new Error(
+      `Missing required parameter(s): ${missing_params.join(", ")}`
+    );
+  }
+
+  const { upload_id, part_ids, ...optionalParams } = parameters.payload;
+  const response = await openai.uploads.complete(
+    upload_id,
+    { part_ids },
+    { ...optionalParams }
+  );
+
+  return response;
+}
+
+async function cancelUpload(parameters) {
+  const clientParams = {
+    ...this.clientParams,
+  };
+
+  const openai = new OpenAI(clientParams);
+
+  // Validate required parameters
+  const required_params = ["upload_id"];
+  const missing_params = required_params.filter(
+    (param) => !parameters.payload?.[param]
+  );
+  if (missing_params.length > 0) {
+    throw new Error(
+      `Missing required parameter(s): ${missing_params.join(", ")}`
+    );
+  }
+
+  const { upload_id, ...optionalParams } = parameters.payload;
+  const response = await openai.uploads.cancel(upload_id, {
+    ...optionalParams,
+  });
+
+  return response;
+}
+
+module.exports = {
+  createUpload,
+  addUploadPart,
+  completeUpload,
+  cancelUpload,
+};

package/src/uploads/template.html

@@ -0,0 +1,21 @@
+      <optgroup style="font-style: normal;" label="☁️ Uploads">
+        <option
+          value="createUpload"
+          data-i18n="OpenaiApi.parameters.createUpload"
+        ></option>
+
+        <option
+        value="addUploadPart"
+        data-i18n="OpenaiApi.parameters.addUploadPart"
+      ></option>
+
+      <option
+      value="completeUpload"
+      data-i18n="OpenaiApi.parameters.completeUpload"
+    ></option>
+
+    <option
+    value="cancelUpload"
+    data-i18n="OpenaiApi.parameters.cancelUpload"
+  ></option>
+      </optgroup>