@inductiv/node-red-openai-api 1.87.3 → 1.103.0-patch.1

package/node.js

@@ -1,5 +1,5 @@
 "use strict";
-const lib = require("./lib.js");
+const OpenaiApi = require("./lib.js");
 
 module.exports = function (RED) {
   class OpenaiApiNode {
@@ -15,11 +15,12 @@ module.exports = function (RED) {
         let clientApiBase = node.service.apiBase;
         let clientOrganization = node.service.organizationId;
 
-        let client = new lib.OpenaiApi(
+        let client = new OpenaiApi(
           clientApiKey,
           clientApiBase,
           clientOrganization
         );
+
         let payload;
 
         const propertyType = node.config.propertyType || "msg";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inductiv/node-red-openai-api",
-  "version": "1.87.3",
+  "version": "1.103.0-patch.1",
   "description": "Enhance your Node-RED projects with advanced AI capabilities.",
   "main": "node.js",
   "engines": {
@@ -29,13 +29,24 @@
     "ai agent",
     "low-code"
   ],
+  "scripts": {
+    "build:html": "gulp build-html",
+    "build:js": "esbuild src/lib.js --bundle --outfile=lib.js --format=cjs --platform=node",
+    "build": "npm run build:html && npm run build:js",
+    "prepare": "npm run build"
+  },
   "dependencies": {
-    "openai": "~4.87.3"
+    "openai": "^4.103.0"
   },
   "author": "Allan Bunch",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/allanbunch/node-red-openai-api.git"
+  },
+  "devDependencies": {
+    "esbuild": "^0.25.5",
+    "gulp": "^5.0.0",
+    "gulp-file-include": "^2.3.0"
   }
 }

package/src/assistants/help.html

@@ -0,0 +1,353 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">🤖 Assistants</summary>
+        <a href="https://platform.openai.com/docs/api-reference/assistants" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+        <h4 style="font-weight: bolder;"> ⋙ Create Assistant</h4>
+        <p>Create an assistant with a model and instructions.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                model
+                <a href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-model"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>ID of the model to use.</dd>
+            <dt class="optional">
+                name
+                <a href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-name"
+                    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 assistant.</dd>
+            <dt class="optional">
+                description
+                <a href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-description"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The description of the assistant.</dd>
+            <dt class="optional">
+                instructions
+                <a href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-instructions"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The system instructions that the assistant uses.</dd>
+            <dt class="optional">
+                tools
+                <a href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tools"
+                    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 tool enabled on the assistant.</dd>
+
+            <dt class="optional">
+                tool_resources
+                <a href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tool_resources"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">object</span>
+            </dt>
+            <dd>A set of resources that are used by the assistant's tools. </dd>
+
+            <dt class="optional">
+                metadata
+                <a href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-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>
+
+            <dt class="optional">
+                temperature
+                <a href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-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. Higher values like 0.8 will make the output more
+                random, while lower values like 0.2 will make it more focused and deterministic.</dd>
+
+            <dt class="optional">
+                top_p
+                <a href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-top_p"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">number</span>
+            </dt>
+            <dd>An alternative to sampling with temperature, called nucleus sampling, where the model considers the
+                results of the tokens with top_p probability mass.</dd>
+
+            <dt class="optional">
+                response_format
+                <a href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-response_format"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Specifies the format that the model must output.</dd>
+
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Assistant</h4>
+        <p>Retrieves an assistant.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                assistant_id
+                <a href="https://platform.openai.com/docs/api-reference/assistants/getAssistant#assistants-getassistant-assistant_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 assistant to retrieve.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Modify Assistant</h4>
+        <p>Modifies an assistant.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                assistant_id
+                <a href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-assistant_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 assistant to retrieve.</dd>
+
+            <dt class="optional">
+                model
+                <a href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-model"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>ID of the model to use.</dd>
+            <dt class="optional">
+                name
+                <a href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-name"
+                    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 assistant.</dd>
+            <dt class="optional">
+                description
+                <a href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-description"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The description of the assistant.</dd>
+            <dt class="optional">
+                instructions
+                <a href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-instructions"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The system instructions that the assistant uses.</dd>
+            <dt class="optional">
+                tools
+                <a href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-tools"
+                    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 tool enabled on the assistant.</dd>
+
+            <dt class="optional">
+                tool_resources
+                <a href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-tool_resources"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">object</span>
+            </dt>
+            <dd>A set of resources that are used by the assistant's tools. </dd>
+
+            <dt class="optional">
+                metadata
+                <a href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-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>
+
+            <dt class="optional">
+                temperature
+                <a href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-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. Higher values like 0.8 will make the output more
+                random, while lower values like 0.2 will make it more focused and deterministic.</dd>
+
+            <dt class="optional">
+                top_p
+                <a href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-top_p"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">number</span>
+            </dt>
+            <dd>An alternative to sampling with temperature, called nucleus sampling, where the model considers the
+                results of the tokens with top_p probability mass.</dd>
+
+            <dt class="optional">
+                response_format
+                <a href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-response_format"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Specifies the format that the model must output.</dd>
+
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Delete Assistant</h4>
+        <p>Delete an assistant.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                assistant_id
+                <a href="https://platform.openai.com/docs/api-reference/assistants/deleteAssistant#assistants-deleteassistant-assistant_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 assistant to delete.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ List Assistants</h4>
+        <p>Returns a list of assistants.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt class="optional">
+                limit
+                <a href="https://platform.openai.com/docs/api-reference/assistants/listAssistants#assistants-listassistants-limit"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>A limit on the number of objects to be returned.</dd>
+            <dt class="optional">
+                order
+                <a href="https://platform.openai.com/docs/api-reference/assistants/listAssistants#assistants-listassistants-order"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Sort order by the created_at timestamp of the objects.</dd>
+            <dt class="optional">
+                after
+                <a href="https://platform.openai.com/docs/api-reference/assistants/listAssistants#assistants-listassistants-after"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>A cursor for use in pagination.</dd>
+            <dt class="optional">
+                before
+                <a href="https://platform.openai.com/docs/api-reference/assistants/listAssistants#assistants-listassistants-before"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>A cursor for use in pagination.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ List Assistant Files</h4>
+        <p>Returns a list of assistant files.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                assistant_id
+                <a href="https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-assistant_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 assistant the file belongs to.</dd>
+            <dt class="optional">
+                limit
+                <a href="https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-limit"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>A limit on the number of objects to be returned.</dd>
+            <dt class="optional">
+                order
+                <a href="https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-order"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Sort order by the created_at timestamp of the objects.</dd>
+            <dt class="optional">
+                after
+                <a href="https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-after"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>A cursor for use in pagination.</dd>
+            <dt class="optional">
+                before
+                <a href="https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-before"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>A cursor for use in pagination.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Create Assistant File</h4>
+        <p>Create an assistant file by attaching a file to an assistant.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                assistant_id
+                <a href="https://platform.openai.com/docs/api-reference/assistants/createAssistantFile#assistants-createassistantfile-assistant_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 assistant for which to create a File.</dd>
+            <dt>
+                file_id
+                <a href="https://platform.openai.com/docs/api-reference/assistants/createAssistantFile#assistants-createassistantfile-file_id"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                A File ID (with purpose="assistants") that the assistant should use.
+            </dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Assistant File</h4>
+        <p>Retrieves an AssistantFile.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                assistant_id
+                <a href="https://platform.openai.com/docs/api-reference/assistants/getAssistantFile#assistants-getassistantfile-assistant_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 assistant who the file belongs to.</dd>
+            <dt>
+                file_id
+                <a href="https://platform.openai.com/docs/api-reference/assistants/getAssistantFile#assistants-getassistantfile-file_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 file we're getting.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Delete Assistant File</h4>
+        <p>Delete an assistant file.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                assistant_id
+                <a href="https://platform.openai.com/docs/api-reference/assistants/deleteAssistantFile#assistants-deleteassistantfile-assistant_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 assistant that the file belongs to.</dd>
+            <dt>
+                file_id
+                <a href="https://platform.openai.com/docs/api-reference/assistants/deleteAssistantFile#assistants-deleteassistantfile-file_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 file to delete.</dd>
+        </dl>
+    </details>
+</section>

package/src/assistants/methods.js

@@ -0,0 +1,47 @@
+const OpenAI = require("openai").OpenAI;
+
+async function listAssistants(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const list = await openai.beta.assistants.list(parameters.payload);
+
+  return [...list.data];
+}
+
+async function createAssistant(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const response = await openai.beta.assistants.create(parameters.payload);
+
+  return response;
+}
+
+async function getAssistant(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { assistant_id, ...params } = parameters.payload;
+  const response = await openai.beta.assistants.retrieve(assistant_id, params);
+
+  return response;
+}
+
+async function modifyAssistant(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { assistant_id, ...params } = parameters.payload;
+  const response = await openai.beta.assistants.update(assistant_id, params);
+
+  return response;
+}
+
+async function deleteAssistant(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { assistant_id, ...params } = parameters.payload;
+  const response = await openai.beta.assistants.del(assistant_id, params);
+
+  return response;
+}
+
+module.exports = {
+  listAssistants,
+  createAssistant,
+  getAssistant,
+  modifyAssistant,
+  deleteAssistant,
+};

package/src/assistants/template.html

@@ -0,0 +1,38 @@
+      <optgroup style="font-style: normal;" label="🤖 Assistants (Beta)">
+        <option
+          value="createAssistant"
+          data-i18n="OpenaiApi.parameters.createAssistant"
+        ></option>
+        <option
+          value="getAssistant"
+          data-i18n="OpenaiApi.parameters.getAssistant"
+        ></option>
+        <option
+          value="modifyAssistant"
+          data-i18n="OpenaiApi.parameters.modifyAssistant"
+        ></option>
+        <option
+          value="deleteAssistant"
+          data-i18n="OpenaiApi.parameters.deleteAssistant"
+        ></option>
+        <option
+          value="listAssistants"
+          data-i18n="OpenaiApi.parameters.listAssistants"
+        ></option>
+        <option
+          value="listAssistantFiles"
+          data-i18n="OpenaiApi.parameters.listAssistantFiles"
+        ></option>
+        <option
+          value="createAssistantFile"
+          data-i18n="OpenaiApi.parameters.createAssistantFile"
+        ></option>
+        <option
+          value="getAssistantFile"
+          data-i18n="OpenaiApi.parameters.getAssistantFile"
+        ></option>
+        <option
+          value="deleteAssistantFile"
+          data-i18n="OpenaiApi.parameters.deleteAssistantFile"
+        ></option>
+      </optgroup>