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

package/src/messages/help.html

@@ -0,0 +1,174 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">📟 Messages</summary>
+        <a href="https://platform.openai.com/docs/api-reference/messages" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+        <h4 style="font-weight: bolder;"> ⋙ List Messages</h4>
+        <p>Returns a list of messages for a given thread.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                thread_id
+                <a href="https://platform.openai.com/docs/api-reference/messages/listMessages#messages-listmessages-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 the messages belong to.</dd>
+            <dt class="optional">
+                limit
+                <a href="https://platform.openai.com/docs/api-reference/messages/listMessages#messages-listmessages-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. Limit can range between
+                1 and 100, and the default is 20.
+            </dd>
+            <dt class="optional">
+                order
+                <a href="https://platform.openai.com/docs/api-reference/messages/listMessages#messages-listmessages-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/messages/listMessages#messages-listmessages-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/messages/listMessages#messages-listmessages-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>
+
+            <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>
+
+        <h4 style="font-weight: bolder;"> ⋙ Create Message</h4>
+        <p>Create a message.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                thread_id
+                <a href="https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-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 create a message for.</dd>
+            <dt>
+                role
+                <a href="https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-role"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The role of the entity that is creating the message.</dd>
+            <dt>
+                content
+                <a href="https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-content"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The content of the message.</dd>
+            <dt class="optional">
+                attachments
+                <a href="https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-attachments"
+                    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 files attached to the message, and the tools they should be added to.</dd>
+            <dt class="optional">
+                metadata
+                <a href="https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-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 Message</h4>
+        <p>Deletes a message.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                thread_id
+                <a href="https://platform.openai.com/docs/api-reference/messages/deleteMessage#messages-deletemessage-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 which this message belongs.</dd>
+            <dt>
+                message_id
+                <a href="https://platform.openai.com/docs/api-reference/messages/deleteMessage#messages-deletemessage-message_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 message to delete.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Message</h4>
+        <p>Retrieve a message.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                thread_id
+                <a href="https://platform.openai.com/docs/api-reference/messages/getMessage#messages-getmessage-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 which this message belongs.</dd>
+            <dt>
+                message_id
+                <a href="https://platform.openai.com/docs/api-reference/messages/getMessage#messages-getmessage-message_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 message to retrieve.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Modify Message</h4>
+        <p>Modifies a message.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                thread_id
+                <a href="https://platform.openai.com/docs/api-reference/messages/modifyMessage#messages-modifymessage-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 which this message belongs.</dd>
+            <dt>
+                message_id
+                <a href="https://platform.openai.com/docs/api-reference/messages/modifyMessage#messages-modifymessage-message_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 message to modify.</dd>
+            <dt class="optional">
+                metadata
+                <a href="https://platform.openai.com/docs/api-reference/messages/modifyMessage#messages-modifymessage-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>
+
+
+    </details>
+</section>

package/src/messages/methods.js

@@ -0,0 +1,48 @@
+const OpenAI = require("openai").OpenAI;
+
+async function listMessages(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { thread_id, ...params } = parameters.payload;
+  const list = await openai.beta.threads.messages.list(thread_id, params);
+
+  return [...list.data];
+}
+
+async function createMessage(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { thread_id, ...params } = parameters.payload;
+  const response = await openai.beta.threads.messages.create(thread_id, params);
+
+  return response;
+}
+
+async function getMessage(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { thread_id, message_id, ...params } = parameters.payload;
+  const response = await openai.beta.threads.messages.retrieve(
+    thread_id,
+    message_id,
+    params
+  );
+
+  return response;
+}
+
+async function modifyMessage(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { thread_id, message_id, ...params } = parameters.payload;
+  const response = await openai.beta.threads.messages.update(
+    thread_id,
+    message_id,
+    params
+  );
+
+  return response;
+}
+
+module.exports = {
+  listMessages,
+  createMessage,
+  getMessage,
+  modifyMessage,
+};

package/src/messages/template.html

@@ -0,0 +1,18 @@
+      <optgroup style="font-style: normal;" label="📟 Messages (Beta)">
+        <option
+          value="listMessages"
+          data-i18n="OpenaiApi.parameters.listMessages"
+        ></option>
+        <option
+          value="createMessage"
+          data-i18n="OpenaiApi.parameters.createMessage"
+        ></option>
+        <option
+          value="getMessage"
+          data-i18n="OpenaiApi.parameters.getMessage"
+        ></option>
+        <option
+          value="modifyMessage"
+          data-i18n="OpenaiApi.parameters.modifyMessage"
+        ></option>
+      </optgroup>

package/src/models/help.html

@@ -0,0 +1,47 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">🧠 Models</summary>
+        <a href="https://platform.openai.com/docs/api-reference/models" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+        <h4 style="font-weight: bolder;"> ⋙ List Models</h4>
+        <p>
+            Lists the currently available models, and provides basic information about
+            each one such as the owner and availability.
+        </p>
+        <dl class="message-properties"></dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Model</h4>
+        <p>
+            Retrieves a model instance, providing basic information about the model
+            such as the owner and permissioning.
+        </p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                model
+                <a href="https://platform.openai.com/docs/api-reference/models/retrieve#models-retrieve-model"
+                    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 model to use for this request</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Delete Fine-tuned Model</h4>
+        <p>
+            Delete a fine-tuned model. You must have the Owner role in your
+            organization to delete a model.
+        </p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                model
+                <a href="https://platform.openai.com/docs/api-reference/models/delete#models-delete-model"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The model to delete</dd>
+        </dl>
+    </details>
+</section>

package/src/models/methods.js

@@ -0,0 +1,30 @@
+const OpenAI = require("openai").OpenAI;
+
+async function listModels(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const list = await openai.models.list(parameters.payload);
+
+  return [...list.data];
+}
+
+async function retrieveModel(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const model = parameters.payload.model;
+  const response = await openai.models.retrieve(model);
+
+  return response;
+}
+
+async function deleteModel(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const model = parameters.payload.model;
+  const response = await openai.models.del(model);
+
+  return response;
+}
+
+module.exports = {
+  listModels,
+  retrieveModel,
+  deleteModel,
+};

package/src/models/template.html

@@ -0,0 +1,14 @@
+      <optgroup style="font-style: normal;" label="🧠 Models">
+        <option
+          value="listModels"
+          data-i18n="OpenaiApi.parameters.listModels"
+        ></option>
+        <option
+          value="retrieveModel"
+          data-i18n="OpenaiApi.parameters.retrieveModel"
+        ></option>
+        <option
+          value="deleteModel"
+          data-i18n="OpenaiApi.parameters.deleteModel"
+        ></option>
+      </optgroup>

package/src/moderations/help.html

@@ -0,0 +1,31 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">✅ Moderations</summary>
+        <a href="https://platform.openai.com/docs/api-reference/moderations" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+        <h4 style="font-weight: bolder;"> ⋙ Create Moderation</h4>
+        <p>Classifies if text violates OpenAI's Content Policy</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                input
+                <a href="https://platform.openai.com/docs/api-reference/moderations/create#moderations-create-input"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string | array</span>
+            </dt>
+            <dd>The input text to classify</dd>
+            <dt class="optional">
+                model
+                <a href="https://platform.openai.com/docs/api-reference/moderations/create#moderations-create-model"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                Two content moderations models are available: text-moderation-stable
+                and text-moderation-latest.
+            </dd>
+        </dl>
+
+    </details>
+</section>

package/src/moderations/methods.js

@@ -0,0 +1,11 @@
+const OpenAI = require("openai").OpenAI;
+
+async function createModeration(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const response = await openai.moderations.create(parameters.payload);
+  return response;
+}
+
+module.exports = {
+  createModeration,
+};

package/src/moderations/template.html

@@ -0,0 +1,6 @@
+      <optgroup style="font-style: normal;" label="✅ Moderations">
+        <option
+          value="createModeration"
+          data-i18n="OpenaiApi.parameters.createModeration"
+        ></option>
+      </optgroup>

package/src/node.html

@@ -0,0 +1,250 @@
+<script type="text/javascript">
+  RED.nodes.registerType("OpenAI API", {
+    category: "AI",
+    color: "#B8B1FB",
+    defaults: {
+      name: { value: "" },
+      property: { value: "payload", required: true },
+      propertyType: { value: "msg" },
+      service: { value: "", type: "Service Host", required: true },
+      method: { value: "", required: true },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "icon.png",
+    label: function () {
+      return this.name || this.method || "OpenAI API";
+    },
+    labelStyle: function () {
+      return this.name ? "node_label_italic" : "";
+    },
+    oneditprepare: function () {
+      var selectedMethod = $("#node-input-method option:selected");
+      if (!selectedMethod.val()) {
+        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>
+
+<script type="text/html" data-template-name="OpenAI API">
+  <div class="form-row">
+    <label for="node-input-name"
+      ><i class="fa fa-tag"></i>
+      <span data-i18n="node-red:common.label.name"></span
+    ></label>
+    <input
+      type="text"
+      id="node-input-name"
+      data-i18n="[placeholder]node-red:common.label.name"
+    />
+  </div>
+  <hr />
+
+  <div class="form-row">
+    <label for="node-input-service"
+      ><i class="fa fa-cloud"></i>
+      <span data-i18n="OpenaiApi.label.serviceHost"></span
+    ></label>
+    <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>
+      <span data-i18n="OpenaiApi.label.method"></span
+    ></label>
+    <select id="node-input-method">
+        @@include('./assistants/template.html')
+        @@include('./audio/template.html')
+        @@include('./batch/template.html')
+        @@include('./chat/template.html')
+        @@include('./container-files/template.html')
+        @@include('./containers/template.html')
+        @@include('./embeddings/template.html')
+        @@include('./files/template.html')
+        @@include('./fine-tuning/template.html')
+        @@include('./images/template.html')
+        @@include('./messages/template.html')
+        @@include('./models/template.html')
+        @@include('./moderations/template.html')
+        @@include('./responses/template.html')
+        @@include('./runs/template.html')
+        @@include('./threads/template.html')
+        @@include('./uploads/template.html')
+        @@include('./vector-stores/template.html')
+        @@include('./vector-store-files/template.html')
+        @@include('./vector-store-file-batches/template.html')
+    </select>
+  </div>
+</script>
+
+<script type="text/html" data-help-name="OpenAI API">
+  <p>
+    OpenAI Platform Services API. Please see the
+    <a href="https://platform.openai.com/docs/api-reference" target="_blank"
+      >OpenAI API Reference</a
+    >
+    for more details.
+  </p>
+  <p><b>Reference</b></p>
+
+  @@include('./assistants/help.html')
+  @@include('./audio/help.html')
+  @@include('./batch/help.html')
+  @@include('./chat/help.html')
+  @@include('./container-files/help.html')
+  @@include('./containers/help.html')
+  @@include('./embeddings/help.html')
+  @@include('./files/help.html')
+  @@include('./fine-tuning/help.html')
+  @@include('./images/help.html')
+  @@include('./messages/help.html')
+  @@include('./models/help.html')
+  @@include('./moderations/help.html')
+  @@include('./responses/help.html')
+  @@include('./runs/help.html')
+  @@include('./threads/help.html')
+  @@include('./uploads/help.html')
+  @@include('./vector-stores/help.html')
+  @@include('./vector-store-files/help.html')
+  @@include('./vector-store-file-batches/help.html')
+</script>
+
+<script type="text/javascript">
+  RED.nodes.registerType("Service Host", {
+    category: "config",
+    defaults: {
+      apiBase: { value: "https://api.openai.com/v1", required: true },
+      secureApiKeyHeaderOrQueryName: { value: "Authorization" },
+      organizationId: { value: "" },
+      secureApiKeyIsQuery: { value: false },
+      name: { value: "" },
+    },
+    credentials: {
+      secureApiKeyValue: { type: "password" },
+      temp: { type: "text" },
+    },
+    label: function () {
+      return this.name || this.host;
+    },
+    labelStyle: function () {
+      return this.name ? "node_label_italic" : "";
+    },
+    oneditprepare: function () {
+      $("#node-config-input-secureApiKeyIsQuery-label").hide();
+      $("#node-config-input-secureApiKeyIsQuery").hide();
+      var selected = $(
+        "#node-config-input-secureApiKeyIsQuery option:selected",
+      );
+      if (!selected.val()) {
+        $("#node-config-input-secureApiKeyIsQuery").val(false);
+      };
+    },
+  });
+</script>
+
+<script type="text/html" data-template-name="Service Host">
+  <div class="form-row">
+    <label id="node-config-input-apiBase-label" for="node-config-input-apiBase"
+      ><i class="fa fa-list"></i>
+      <span data-i18n="OpenaiApi.label.apiBase"></span
+    ></label>
+    <input
+      type="text"
+      id="node-config-input-apiBase"
+      placeholder="https://api.openai.com/v1"
+    />
+  </div>
+  <div class="form-row">
+    <label
+      id="node-config-input-secureApiKeyHeaderOrQueryName-label"
+      for="node-config-input-secureApiKeyHeaderOrQueryName"
+      ><i class="fa fa-list"></i>
+      <span data-i18n="OpenaiApi.label.header"></span
+    ></label>
+    <input
+      type="text"
+      id="node-config-input-secureApiKeyHeaderOrQueryName"
+      placeholder=""
+    />
+  </div>
+  <div class="form-row">
+    <label
+      id="node-config-input-secureApiKeyValue-label"
+      for="node-config-input-secureApiKeyValue"
+      ><i class="fa fa-lock"></i>
+      <span data-i18n="OpenaiApi.label.apiKey"></span
+    ></label>
+    <input
+      type="password"
+      id="node-config-input-secureApiKeyValue"
+      placeholder=""
+    />
+  </div>
+  <div class="form-row">
+    <label
+      id="node-config-input-organizationId-label"
+      for="node-config-input-organizationId"
+      ><i class="fa fa-list"></i>
+      <span data-i18n="OpenaiApi.label.organizationId"></span
+    ></label>
+    <input
+      type="text"
+      id="node-config-input-organizationId"
+      placeholder="OpenAI Organization Id"
+    />
+  </div>
+  <div class="form-row">
+    <label
+      id="node-config-input-secureApiKeyIsQuery-label"
+      for="node-config-input-secureApiKeyIsQuery"
+      ><i class="fa fa-dot-circle-o"></i>
+      <span data-i18n="OpenaiApi.label.isQuery"></span
+    ></label>
+    <select id="node-config-input-secureApiKeyIsQuery">
+      <option value="true">true</option>
+      <option value="false">false</option>
+    </select>
+  </div>
+
+  <div class="form-row">
+    <label for="node-config-input-name"
+      ><i class="fa fa-tag"></i>
+      <span data-i18n="node-red:common.label.name"></span
+    ></label>
+    <input
+      type="text"
+      id="node-config-input-name"
+      data-i18n="[placeholder]node-red:common.label.name"
+    />
+  </div>
+</script>
+
+<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>