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

package/src/images/help.html

@@ -1,7 +1,7 @@
 <section>
     <details>
         <summary style="font-weight: bold;">🖼️ Images</summary>
-        <a href="https://platform.openai.com/docs/api-reference/images" target="_blank">Official Documentation
+        <a href="https://developers.openai.com/api/reference/typescript/resources/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>
@@ -10,36 +10,26 @@
 
             <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>
@@ -48,8 +38,6 @@
             </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>
@@ -59,8 +47,6 @@
             </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>
@@ -68,8 +54,6 @@
             </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>
@@ -87,22 +71,16 @@
 
             <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>
@@ -111,29 +89,21 @@
             </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>
@@ -142,8 +112,6 @@
             </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>
@@ -159,43 +127,31 @@
 
             <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>

package/src/lib.js

@@ -6,26 +6,71 @@ 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 conversations = require("./conversations/methods.js");
 const embeddings = require("./embeddings/methods.js");
+const evals = require("./evals/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 realtime = require("./realtime/methods.js");
 const responses = require("./responses/methods.js");
 const runs = require("./runs/methods.js");
+const skills = require("./skills/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");
+const videos = require("./videos/methods.js");
+const webhooks = require("./webhooks/methods.js");
+
+function normalizeHeaderOrQueryName(headerOrQueryName) {
+  if (typeof headerOrQueryName !== "string") {
+    return "Authorization";
+  }
+
+  const trimmedHeaderOrQueryName = headerOrQueryName.trim();
+  return trimmedHeaderOrQueryName || "Authorization";
+}
+
+function createApiKeyTransportParams(apiKey, apiKeyTransport = {}) {
+  const headerOrQueryName = normalizeHeaderOrQueryName(
+    apiKeyTransport.headerOrQueryName
+  );
+
+  if (apiKeyTransport.isQuery) {
+    return {
+      defaultHeaders: {
+        Authorization: null,
+      },
+      defaultQuery: {
+        [headerOrQueryName]: apiKey,
+      },
+    };
+  }
+
+  if (headerOrQueryName.toLowerCase() === "authorization") {
+    return {};
+  }
+
+  return {
+    defaultHeaders: {
+      Authorization: null,
+      [headerOrQueryName]: apiKey,
+    },
+  };
+}
 
 class OpenaiApi {
-  constructor(apiKey, baseURL, organization) {
+  constructor(apiKey, baseURL, organization, apiKeyTransport) {
     this.clientParams = {
       apiKey,
       baseURL,
       organization,
+      ...createApiKeyTransportParams(apiKey, apiKeyTransport),
     };
   }
 }
@@ -39,16 +84,23 @@ Object.assign(
   chat,
   container_files,
   containers,
+  conversations,
   embeddings,
+  evals,
   files,
   fine_tuning,
   images,
+  messages,
   models,
   moderations,
+  realtime,
   responses,
   runs,
+  skills,
   threads,
   uploads,
+  videos,
+  webhooks,
   vectorStoreFileBatches,
   vectorStoreFiles,
   vectorStores

package/src/messages/help.html

@@ -1,7 +1,7 @@
 <section>
     <details>
         <summary style="font-weight: bold;">📟 Messages</summary>
-        <a href="https://platform.openai.com/docs/api-reference/messages" target="_blank">Official Documentation
+        <a href="https://developers.openai.com/api/reference/typescript/resources/beta/threads/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>
@@ -10,15 +10,11 @@
 
             <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>
@@ -27,30 +23,22 @@
             </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>
@@ -64,36 +52,26 @@
 
             <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>
@@ -106,15 +84,11 @@
 
             <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>
@@ -127,20 +101,34 @@
 
             <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;"> ⋙ Delete Message</h4>
+        <p>Delete a message.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                thread_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The ID of the thread to which this message belongs.</dd>
+
+            <dt>
+                message_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The ID of the thread to which this message belongs.</dd>
+        </dl>
+
         <h4 style="font-weight: bolder;"> ⋙ Modify Message</h4>
         <p>Modifies a message.</p>
         <dl class="message-properties">
@@ -148,27 +136,19 @@
 
             <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

@@ -40,9 +40,22 @@ async function modifyMessage(parameters) {
   return response;
 }
 
+async function deleteMessage(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { thread_id, message_id, ...params } = parameters.payload;
+  const response = await openai.beta.threads.messages.del(
+    thread_id,
+    message_id,
+    params
+  );
+
+  return response;
+}
+
 module.exports = {
   listMessages,
   createMessage,
   getMessage,
   modifyMessage,
+  deleteMessage,
 };

package/src/messages/template.html

@@ -1,18 +1,7 @@
-      <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>
+<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>
+  <option value="deleteMessage" data-i18n="OpenaiApi.parameters.deleteMessage"></option>
+</optgroup>

package/src/models/help.html

@@ -1,7 +1,7 @@
 <section>
     <details>
         <summary style="font-weight: bold;">🧠 Models</summary>
-        <a href="https://platform.openai.com/docs/api-reference/models" target="_blank">Official Documentation
+        <a href="https://developers.openai.com/api/reference/typescript/resources/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>
@@ -20,8 +20,6 @@
 
             <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>
@@ -37,8 +35,6 @@
 
             <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>

package/src/moderations/help.html

@@ -1,7 +1,7 @@
 <section>
     <details>
         <summary style="font-weight: bold;">✅ Moderations</summary>
-        <a href="https://platform.openai.com/docs/api-reference/moderations" target="_blank">Official Documentation
+        <a href="https://developers.openai.com/api/reference/typescript/resources/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>
@@ -10,15 +10,11 @@
 
             <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>