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

package/src/audio/help.html

@@ -0,0 +1,193 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">🔉 Audio</summary>
+        <a href="https://platform.openai.com/docs/api-reference/audio" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+        <h4 style="font-weight: bolder;"> ⋙ Create Speech</h4>
+        <p>Generates audio from the input text.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                input
+                <a href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-input"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The text to generate audio for.</dd>
+
+            <dt>
+                model
+                <a href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-model"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>One of the available TTS models: <code>tts-1</code>, <code>tts-1-hd</code> or
+                <code>gpt-4o-mini-tts</code>.</dd>
+
+            <dt>
+                voice
+                <a href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-voice"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                The voice to use when generating the audio. Supported voices are <code>alloy</code>, <code>ash</code>,
+                <code>coral</code>, <code>echo</code>, <code>fable</code>, <code>onyx</code>, <code>nova</code>,
+                <code>sage</code> and <code>shimmer</code>.
+            </dd>
+
+            <dt class="optional">
+                instructions
+                <a href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-instructions"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                Control the voice of your generated audio with additional instructions. Does not work with
+                <code>tts-1</code> or <code>tts-1-hd</code>.
+            </dd>
+
+            <dt class="optional">
+                response_format
+                <a href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-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 to audio in. Supported formats are mp3, opus, aac, flac, wav, and pcm.
+            </dd>
+
+            <dt class="optional">
+                speed
+                <a href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-speed"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">number</span>
+            </dt>
+            <dd>
+                The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0
+                is the default.
+            </dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Create Transcription</h4>
+        <p>Transcribes audio into the input language.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                file
+                <a href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-file"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">file</span>
+            </dt>
+            <dd>
+                Absolute path to the file that's being transcribed, in one of these formats: flac, mp3, mp4, mpeg, mpga,
+                m4a, ogg, wav, or webm.
+            </dd>
+            <dt>
+                model
+                <a href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-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">
+                language
+                <a href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-language"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The language of the input audio.</dd>
+            <dt class="optional">
+                prompt
+                <a href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-prompt"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                An optional text to guide the model's style or continue a previous audio
+                segment.
+            </dd>
+            <dt class="optional">
+                response_format
+                <a href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-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 of the transcript output, in one of these options: json,
+                text, srt, verbose_json, or vtt.
+            </dd>
+            <dt class="optional">
+                temperature
+                <a href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-temperature"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">number</span>
+            </dt>
+            <dd>The sampling temperature, between 0 and 1.</dd>
+
+            <dt class="optional">
+                timestamp_granularities
+                <a href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-timestamp_granularities"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">array</span>
+            </dt>
+            <dd>The timestamp granularities to populate for this transcription. <code>response_format</code> must be set
+                to <code>verbose_json</code> to use timestamp granularities. Either or both of these options are
+                supported: <code>word</code>, or <code>segment</code>.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Create Translation</h4>
+        <p>Translates audio into English.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                file
+                <a href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-file"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">file</span>
+            </dt>
+            <dd>
+                Absolute path to the file that's being translated, in one of these formats: flac, mp3, mp4, mpeg, mpga,
+                m4a, ogg, wav, or webm.
+            </dd>
+            <dt>
+                model
+                <a href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-model"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type"></span>
+            </dt>
+            <dd>ID of the model to use.</dd>
+            <dt class="optional">
+                prompt
+                <a href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-prompt"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                An optional text to guide the model's style or continue a previous audio
+                segment.
+            </dd>
+            <dt class="optional">
+                response_format
+                <a href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-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 of the transcript output, in one of these options: json,
+                text, srt, verbose_json, or vtt.
+            </dd>
+            <dt class="optional">
+                temperature
+                <a href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-temperature"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">number</span>
+            </dt>
+            <dd>The sampling temperature, between 0 and 1.</dd>
+        </dl>
+
+    </details>
+</section>

package/src/audio/methods.js

@@ -0,0 +1,38 @@
+const OpenAI = require("openai").OpenAI;
+const fs = require("fs");
+
+async function createSpeech(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const audio = await openai.audio.speech.create(parameters.payload);
+  const response = Buffer.from(await audio.arrayBuffer());
+
+  return response;
+}
+
+async function createTranscription(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  let { file, ...params } = parameters.payload;
+
+  params.file = fs.createReadStream(file);
+
+  const response = await openai.audio.transcriptions.create(params);
+
+  return response;
+}
+
+async function createTranslation(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  let { file, ...params } = parameters.payload;
+
+  params.file = fs.createReadStream(file);
+
+  const response = await openai.audio.translations.create(params);
+
+  return response;
+}
+
+module.exports = {
+  createSpeech,
+  createTranscription,
+  createTranslation,
+};

package/src/audio/template.html

@@ -0,0 +1,14 @@
+      <optgroup style="font-style: normal;" label="🔉 Audio">
+        <option
+          value="createSpeech"
+          data-i18n="OpenaiApi.parameters.createSpeech"
+        ></option>
+        <option
+          value="createTranscription"
+          data-i18n="OpenaiApi.parameters.createTranscription"
+        ></option>
+        <option
+          value="createTranslation"
+          data-i18n="OpenaiApi.parameters.createTranslation"
+        ></option>
+      </optgroup>

package/src/batch/help.html

@@ -0,0 +1,97 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">📦 Batch</summary>
+        <a href="https://platform.openai.com/docs/api-reference/batch" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+        <h4 style="font-weight: bolder;"> ⋙ Create Batch</h4>
+        <p>Creates and executes a batch from an uploaded file of requests.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                input_file_id
+                <a href="https://platform.openai.com/docs/api-reference/batch/create#batch-create-input_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 an uploaded file that contains requests for the new batch.</dd>
+            <dt>
+                endpoint
+                <a href="https://platform.openai.com/docs/api-reference/batch/create#batch-create-endpoint"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The endpoint to be used for all requests in the batch. Currently only /v1/chat/completions is supported.
+            </dd>
+            <dt>
+                completion_window
+                <a href="https://platform.openai.com/docs/api-reference/batch/create#batch-create-completion_window"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                The time frame within which the batch should be processed. Currently only 24h is supported.
+            </dd>
+            <dt class="optional">
+                metadata
+                <a href="https://platform.openai.com/docs/api-reference/batch/create#batch-create-metadata"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>
+                Optional custom metadata for the batch.
+            </dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Batch</h4>
+        <p>Retrieves a batch.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                batch_id
+                <a href="https://platform.openai.com/docs/api-reference/batch/retrieve#batch-retrieve-batch_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 batch to retrieve.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Cancel Batch</h4>
+        <p>Cancels an in-progress batch.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                batch_id
+                <a href="https://platform.openai.com/docs/api-reference/batch/cancel#batch-cancel-batch_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 batch to cancel.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ List Batch</h4>
+        <p>List your organization's batches.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt class="optional">
+                after
+                <a href="https://platform.openai.com/docs/api-reference/batch/list#batch-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>A cursor for use in pagination. after is an object ID that defines your place in the list.</dd>
+
+            <dt class="optional">
+                limit
+                <a href="https://platform.openai.com/docs/api-reference/batch/list#batch-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>A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is
+                20.</dd>
+        </dl>
+
+
+    </details>
+</section>

package/src/batch/methods.js

@@ -0,0 +1,39 @@
+const OpenAI = require("openai").OpenAI;
+
+async function createBatch(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const response = await openai.batches.create(parameters.payload);
+
+  return response;
+}
+
+async function retrieveBatch(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { batch_id, ...params } = parameters.payload;
+  const response = await openai.batches.retrieve(batch_id, params);
+
+  return response;
+}
+
+async function listBatch(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const list = await openai.batches.list(parameters.payload);
+  const batches = [...list.data];
+
+  return batches;
+}
+
+async function cancelBatch(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { batch_id, ...params } = parameters.payload;
+  const response = await openai.batches.cancel(batch_id, params);
+
+  return response;
+}
+
+module.exports = {
+  createBatch,
+  retrieveBatch,
+  listBatch,
+  cancelBatch,
+};

package/src/batch/template.html

@@ -0,0 +1,19 @@
+      <!-- Batch Endpoint-->
+      <optgroup style="font-style: normal;" label="📦 Batch">
+        <option
+          value="createBatch"
+          data-i18n="OpenaiApi.parameters.createBatch"
+        ></option>
+        <option
+          value="retrieveBatch"
+          data-i18n="OpenaiApi.parameters.retrieveBatch"
+        ></option>
+        <option
+          value="cancelBatch"
+          data-i18n="OpenaiApi.parameters.cancelBatch"
+        ></option>
+        <option
+          value="listBatch"
+          data-i18n="OpenaiApi.parameters.listBatch"
+        ></option>
+      </optgroup>