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

package/src/fine-tuning/help.html

@@ -0,0 +1,187 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">🔧 Fine-tuning</summary>
+        <a href="https://platform.openai.com/docs/api-reference/fine-tuning" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+        <h4 style="font-weight: bolder;"> ⋙ Create Fine-tuning Job</h4>
+        <p>
+            Creates a job that fine-tunes a specified model from a given dataset.
+            Response includes details of the enqueued job including job status and the
+            name of the fine-tuned models once complete.
+        </p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                model
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-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>The name of the model to fine-tune.</dd>
+            <dt>
+                training_file
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-training_file"
+                    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 an uploaded file that contains training data.</dd>
+
+            <dt class="optional">
+                suffix
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-suffix"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                A string of up to 18 characters that will be added to your fine-tuned
+                model name.
+            </dd>
+
+            <dt class="optional">
+                validation_file
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-validation_file"
+                    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 an uploaded file that contains validation data.</dd>
+
+            <dt class="optional">
+                integrations
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-integrations"
+                    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 integrations to enable for your fine-tuning job.</dd>
+
+            <dt class="optional">
+                seed
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-seed"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">array</span>
+            </dt>
+            <dd>The seed controls the reproducibility of the job.</dd>
+
+            <dt class="optional">
+                method
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-method"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">object</span>
+            </dt>
+            <dd>The method used for fine-tuning.</dd>
+
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ List Fine-tuning Jobs</h4>
+        <p>List your organization's fine-tuning jobs</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt class="optional">
+                after
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list#fine-tuning-list-after"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Identifier for the last job from the previous pagination request.</dd>
+            <dt class="optional">
+                limit
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list#fine-tuning-list-limit"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>Number of fine-tuning jobs to retrieve.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Fine-tuning Job</h4>
+        <p>Get info about a fine-tuning job.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                fine_tuning_job_id
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/retrieve#fine-tuning-retrieve-fine_tuning_job_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 fine-tuning job.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ List Fine-tuning Events</h4>
+        <p>Get status updates for a fine-tuning job.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                fine_tuning_job_id
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list-events#fine-tuning-list-events-fine_tuning_job_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 fine-tuning job to get events for.</dd>
+            <dt class="optional">
+                after
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list-events#fine-tuning-list-events-after"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                Identifier for the last event from the previous pagination request.
+            </dd>
+            <dt class="optional">
+                limit
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list-events#fine-tuning-list-events-limit"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>Number of events to retrieve.</dd>
+        </dl>
+
+        <!-- >>> Begin List Fine-tuning Checkpoints -->
+        <h4 style="font-weight: bolder;"> ⋙ List Fine-tuning Checkpoints</h4>
+        <p>List checkpoints for a fine-tuning job.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                fine_tuning_job_id
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list-checkpoints#fine-tuning-list-checkpoints-fine_tuning_job_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 fine-tuning job to get checkpoints for.</dd>
+            <dt class="optional">
+                after
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list-checkpoints#fine-tuning-list-checkpoints-after"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                Identifier for the last checkpoint ID from the previous pagination request.
+            </dd>
+            <dt class="optional">
+                limit
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/list-checkpoints#fine-tuning-list-checkpoints-limit"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>Number of events to retrieve.</dd>
+        </dl>
+        <!-- <<< End List Fine-tuning Checkpoints -->
+
+        <h4 style="font-weight: bolder;"> ⋙ Cancel Fine-tuning Job</h4>
+        <p>Immediately cancel a fine-tune job.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                fine_tuning_job_id
+                <a href="https://platform.openai.com/docs/api-reference/fine-tuning/cancel#fine-tuning-cancel-fine_tuning_job_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 fine-tuning job to cancel.</dd>
+        </dl>
+
+    </details>
+</section>

package/src/fine-tuning/methods.js

@@ -0,0 +1,68 @@
+const OpenAI = require("openai").OpenAI;
+
+async function createFineTuningJob(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const response = await openai.fineTuning.jobs.create(parameters.payload);
+
+  return response;
+}
+
+async function listPaginatedFineTuningJobs(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const list = await openai.fineTuning.jobs.list(parameters.payload);
+
+  return [...list.data];
+}
+
+async function retrieveFineTuningJob(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { fine_tuning_job_id, ...params } = parameters.payload;
+  const response = await openai.fineTuning.jobs.retrieve(
+    fine_tuning_job_id,
+    params
+  );
+
+  return response;
+}
+
+async function listFineTuningEvents(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { fine_tuning_job_id, ...params } = parameters.payload;
+  const list = await openai.fineTuning.jobs.listEvents(
+    fine_tuning_job_id,
+    params
+  );
+
+  return [...list.data];
+}
+
+async function listFineTuningCheckpoints(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { fine_tuning_job_id, ...params } = parameters.payload;
+  const list = await openai.fineTuning.jobs.checkpoints.list(
+    fine_tuning_job_id,
+    params
+  );
+
+  return [...list.data];
+}
+
+async function cancelFineTuningJob(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { fine_tuning_job_id, ...params } = parameters.payload;
+  const response = await openai.fineTuning.jobs.cancel(
+    fine_tuning_job_id,
+    params
+  );
+
+  return response;
+}
+
+module.exports = {
+  createFineTuningJob,
+  listPaginatedFineTuningJobs,
+  retrieveFineTuningJob,
+  listFineTuningEvents,
+  listFineTuningCheckpoints,
+  cancelFineTuningJob,
+};

package/src/fine-tuning/template.html

@@ -0,0 +1,26 @@
+      <optgroup style="font-style: normal;" label="🔧 Fine-tuning">
+        <option
+          value="createFineTuningJob"
+          data-i18n="OpenaiApi.parameters.createFineTuningJob"
+        ></option>
+        <option
+          value="listPaginatedFineTuningJobs"
+          data-i18n="OpenaiApi.parameters.listPaginatedFineTuningJobs"
+        ></option>
+        <option
+          value="retrieveFineTuningJob"
+          data-i18n="OpenaiApi.parameters.retrieveFineTuningJob"
+        ></option>
+        <option
+          value="listFineTuningEvents"
+          data-i18n="OpenaiApi.parameters.listFineTuningEvents"
+        ></option>
+        <option
+          value="listFineTuningCheckpoints"
+          data-i18n="OpenaiApi.parameters.listFineTuningCheckpoints"
+        ></option>
+        <option
+          value="cancelFineTuningJob"
+          data-i18n="OpenaiApi.parameters.cancelFineTuningJob"
+        ></option>
+      </optgroup>

package/src/images/help.html

@@ -0,0 +1,208 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">🖼️ Images</summary>
+        <a href="https://platform.openai.com/docs/api-reference/images" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+        <h4 style="font-weight: bolder;"> ⋙ Create Image</h4>
+        <p>Creates an image given a prompt.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                prompt
+                <a href="https://platform.openai.com/docs/api-reference/images/create#images-create-prompt"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>A text description of the desired image(s).</dd>
+            <dt class="optional">
+                model
+                <a href="https://platform.openai.com/docs/api-reference/images/create#images-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>The model to use for image generation.</dd>
+            <dt class="optional">
+                n
+                <a href="https://platform.openai.com/docs/api-reference/images/create#images-create-n"
+                    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 images to generate.</dd>
+            <dt class="optional">
+                quality
+                <a href="https://platform.openai.com/docs/api-reference/images/create#images-create-quality"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The quality of the image that will be generated.</dd>
+            <dt class="optional">
+                response_format
+                <a href="https://platform.openai.com/docs/api-reference/images/create#images-create-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>
+                The format in which the generated images are returned. Must be one of
+                url or b64_json.
+            </dd>
+            <dt class="optional">
+                size
+                <a href="https://platform.openai.com/docs/api-reference/images/create#images-create-size"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                The size of the generated images. Must be one of 256x256, 512x512, or
+                1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or
+                1024x1792.
+            </dd>
+            <dt class="optional">
+                style
+                <a href="https://platform.openai.com/docs/api-reference/images/create#images-create-style"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                The style of the generated images. Must be one of vivid or natural.
+            </dd>
+            <dt class="optional">
+                user
+                <a href="https://platform.openai.com/docs/api-reference/images/create#images-create-user"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                A unique identifier representing your end-user, which can help OpenAI to
+                monitor and detect abuse.
+            </dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Create Image Edit</h4>
+        <p>
+            Creates an edited or extended image given an original image and a prompt.
+        </p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                image
+                <a href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-image"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The image to edit.</dd>
+            <dt>
+                prompt
+                <a href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-prompt"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>A text description of the desired image(s).</dd>
+            <dt class="optional">
+                mask
+                <a href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-mask"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                An additional image whose fully transparent areas (e.g. where alpha is
+                zero) indicate where image should be edited.
+            </dd>
+            <dt class="optional">
+                model
+                <a href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-model"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type"></span>
+            </dt>
+            <dd>The model to use for image generation.</dd>
+            <dt class="optional">
+                n
+                <a href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-n"
+                    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 images to generate. Must be between 1 and 10.</dd>
+            <dt class="optional">
+                size
+                <a href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-size"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The size of the generated images.</dd>
+            <dt class="optional">
+                response_format
+                <a href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-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>
+                The format in which the generated images are returned. Must be one of
+                url or b64_json.
+            </dd>
+            <dt class="optional">
+                user
+                <a href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-user"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                A unique identifier representing your end-user, which can help OpenAI to
+                monitor and detect abuse.
+            </dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Create Image Variation</h4>
+        <p>Creates a variation of a given image.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                image
+                <a href="https://platform.openai.com/docs/api-reference/images/createVariation#images-createvariation-image"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The image to use as the basis for the variation(s).</dd>
+            <dt>
+                model
+                <a href="https://platform.openai.com/docs/api-reference/images/createVariation#images-createvariation-model"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type"></span>
+            </dt>
+            <dd>The model to use for image generation.</dd>
+            <dt>
+                n
+                <a href="https://platform.openai.com/docs/api-reference/images/createVariation#images-createvariation-n"
+                    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 images to generate.</dd>
+            <dt>
+                response_format
+                <a href="https://platform.openai.com/docs/api-reference/images/createVariation#images-createvariation-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>The format in which the generated images are returned.</dd>
+            <dt>
+                size
+                <a href="https://platform.openai.com/docs/api-reference/images/createVariation#images-createvariation-size"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The size of the generated images.</dd>
+            <dt>
+                user
+                <a href="https://platform.openai.com/docs/api-reference/images/createVariation#images-createvariation-user"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                A unique identifier representing your end-user, which can help OpenAI to
+                monitor and detect abuse.
+            </dd>
+        </dl>
+
+    </details>
+</section>

package/src/images/methods.js

@@ -0,0 +1,38 @@
+const OpenAI = require("openai").OpenAI;
+const fs = require("fs");
+
+async function createImage(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const response = await openai.images.generate(parameters.payload);
+
+  return response.data;
+}
+
+async function createImageEdit(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  let { image, mask, ...params } = parameters.payload;
+
+  params.image = fs.createReadStream(image);
+  if (mask) {
+    params.mask = fs.createReadStream(mask);
+  }
+  const response = await openai.images.edit(params);
+
+  return response.data;
+}
+
+async function createImageVariation(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  let { image, ...params } = parameters.payload;
+
+  params.image = fs.createReadStream(image);
+  const response = await openai.images.createVariation(params);
+
+  return response.data;
+}
+
+module.exports = {
+  createImage,
+  createImageEdit,
+  createImageVariation,
+};

package/src/images/template.html

@@ -0,0 +1,14 @@
+      <optgroup style="font-style: normal;" label="🖼️ Images">
+        <option
+          value="createImage"
+          data-i18n="OpenaiApi.parameters.createImage"
+        ></option>
+        <option
+          value="createImageEdit"
+          data-i18n="OpenaiApi.parameters.createImageEdit"
+        ></option>
+        <option
+          value="createImageVariation"
+          data-i18n="OpenaiApi.parameters.createImageVariation"
+        ></option>
+      </optgroup>

package/src/lib.js

@@ -0,0 +1,60 @@
+"use strict";
+
+const assistants = require("./assistants/methods.js");
+const audio = require("./audio/methods.js");
+const batch = require("./batch/methods.js");
+const chat = require("./chat/methods.js");
+const container_files = require("./container-files/methods.js");
+const containers = require("./containers/methods.js");
+const embeddings = require("./embeddings/methods.js");
+const files = require("./files/methods.js");
+const fine_tuning = require("./fine-tuning/methods.js");
+const images = require("./images/methods.js");
+const messages = require("./messages/methods.js");
+const models = require("./models/methods.js");
+const moderations = require("./moderations/methods.js");
+const responses = require("./responses/methods.js");
+const runs = require("./runs/methods.js");
+const threads = require("./threads/methods.js");
+const uploads = require("./uploads/methods.js");
+const vectorStoreFileBatches = require("./vector-store-file-batches/methods.js");
+const vectorStoreFiles = require("./vector-store-files/methods.js");
+const vectorStores = require("./vector-stores/methods.js");
+
+class OpenaiApi {
+  constructor(apiKey, baseURL, organization) {
+    this.clientParams = {
+      apiKey,
+      baseURL,
+      organization,
+    };
+  }
+}
+
+// Attach all exported methods as instance methods
+Object.assign(
+  OpenaiApi.prototype,
+  assistants,
+  audio,
+  batch,
+  chat,
+  container_files,
+  containers,
+  embeddings,
+  files,
+  fine_tuning,
+  images,
+  messages,
+  models,
+  moderations,
+  responses,
+  runs,
+  threads,
+  uploads,
+  vectorStoreFileBatches,
+  vectorStoreFiles,
+  vectorStores
+);
+
+// Export the class
+module.exports = OpenaiApi;