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

package/src/vector-store-files/help.html

@@ -1,7 +1,7 @@
 <section>
     <details>
         <summary style="font-weight: bold;">📑 Vector Store Files</summary>
-        <a href="https://platform.openai.com/docs/api-reference/vector-stores-files" target="_blank">Official
+        <a href="https://developers.openai.com/api/reference/typescript/resources/vector_stores/files/" target="_blank">Official
             Documentation
             <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
 
@@ -11,16 +11,12 @@
             <h4>msg.payload Properties</h4>
             <dt>
                 vector_store_id
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/createFile#vector-stores-files-createfile-vector_store_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 vector store for which to create a File.</dd>
 
             <dt>
                 file_id
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/createFile#vector-stores-files-createfile-file_id"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">string</span>
             </dt>
             <dd>A File ID that the vector store should use. Useful for tools like file_search that can access files.
@@ -34,16 +30,12 @@
             <h4>msg.payload Properties</h4>
             <dt>
                 vector_store_id
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-vector_store_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 vector store that the files belong to.</dd>
 
             <dt class="optional">
                 limit
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-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
@@ -51,8 +43,6 @@
 
             <dt class="optional">
                 order
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-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. asc for ascending order and desc for descending
@@ -60,24 +50,18 @@
 
             <dt class="optional">
                 before
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-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. before is an object ID that defines your place in the list.</dd>
 
             <dt class="optional">
                 after
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-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">
                 filter
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles#vector-stores-files-listfiles-filter"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">string</span>
             </dt>
             <dd>Filter by file status. One of in_progress, completed, failed, cancelled.</dd>
@@ -90,16 +74,12 @@
             <h4>msg.payload Properties</h4>
             <dt>
                 vector_store_id
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/getFile#vector-stores-files-getfile-vector_store_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 vector store that the file belongs to.</dd>
 
             <dt>
                 file_id
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/getFile#vector-stores-files-getfile-file_id"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">string</span>
             </dt>
             <dd>The ID of the file being retrieved.</dd>
@@ -112,16 +92,12 @@
             <h4>msg.payload Properties</h4>
             <dt>
                 vector_store_id
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/deleteFile#vector-stores-files-deletefile-vector_store_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 vector store that the file belongs to.</dd>
 
             <dt>
                 file_id
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores-files/deleteFile#vector-stores-files-deletefile-file_id"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">string</span>
             </dt>
             <dd>The ID of the file to remove from the vector store.</dd>

package/src/vector-store-files/methods.js

@@ -26,7 +26,10 @@ async function retrieveVectorStoreFile(parameters) {
 
   const openai = new OpenAI(this.clientParams);
   const { vector_store_id, file_id } = parameters.payload;
-  const response = openai.vectorStores.files.retrieve(vector_store_id, file_id);
+  const response = await openai.vectorStores.files.retrieve(
+    vector_store_id,
+    file_id
+  );
 
   return response;
 }
@@ -36,7 +39,7 @@ async function deleteVectorStoreFile(parameters) {
 
   const openai = new OpenAI(this.clientParams);
   const { vector_store_id, file_id, ...params } = parameters.payload;
-  const response = openai.vectorStores.files.del(
+  const response = await openai.vectorStores.files.del(
     vector_store_id,
     file_id,
     params

package/src/vector-stores/help.html

@@ -1,7 +1,7 @@
 <section>
     <details>
         <summary style="font-weight: bold;">🗃️ Vector Stores</summary>
-        <a href="https://platform.openai.com/docs/api-reference/vector-stores" target="_blank">Official Documentation
+        <a href="https://developers.openai.com/api/reference/typescript/resources/vector_stores/" target="_blank">Official Documentation
             <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
         <h4 style="font-weight: bolder;"> ⋙ Create Vector Store</h4>
         <p>Create a vector store.</p>
@@ -9,8 +9,7 @@
             <h4>msg.payload Properties</h4>
             <dt class="optional">
                 file_ids
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores/create" 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 File IDs that the vector store should use. Useful for tools like file_search that can access
@@ -18,32 +17,24 @@
 
             <dt class="optional">
                 name
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores/create#vector-stores-create-name"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">string</span>
             </dt>
             <dd>The name of the vector store.</dd>
 
             <dt class="optional">
                 expires_after
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores/create#vector-stores-create-expires_after"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">object</span>
             </dt>
             <dd>The expiration policy for a vector store.</dd>
 
             <dt class="optional">
                 chunking_strategy
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores/create#vector-stores-create-chunking_strategy"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">object</span>
             </dt>
             <dd>The chunking strategy used to chunk the file(s).</dd>
 
             <dt class="optional">
                 metadata
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores/create#vector-stores-create-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. This can be useful for storing additional
@@ -58,8 +49,6 @@
 
             <dt class="optional">
                 limit
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores/list#vector-stores-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
@@ -67,8 +56,6 @@
 
             <dt class="optional">
                 order
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores/list#vector-stores-list-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. asc for ascending order and desc for descending
@@ -76,16 +63,12 @@
 
             <dt class="optional">
                 after
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores/list#vector-stores-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">
                 before
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores/list#vector-stores-list-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. before is an object ID that defines your place in the list.</dd>
@@ -98,8 +81,6 @@
 
             <dt>
                 vector_store_id
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores/retrieve#vector-stores-retrieve-vector_store_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 vector store to retrieve.</dd>
@@ -112,32 +93,24 @@
 
             <dt>
                 vector_store_id
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores/modify#vector-stores-modify-vector_store_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 vector store to modify.</dd>
 
             <dt class="optional">
                 name
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores/modify#vector-stores-modify-name"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">string</span>
             </dt>
             <dd>The name of the vector store.</dd>
 
             <dt class="optional">
                 expires_after
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores/modify#vector-stores-modify-expires_after"
-                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                 <span class="property-type">object</span>
             </dt>
             <dd>The expiration policy for a vector store.</dd>
 
             <dt class="optional">
                 metadata
-                <a href="https://platform.openai.com/docs/api-reference/vector-stores/modify#vector-stores-modify-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>
@@ -150,8 +123,6 @@
 
                 <dt>
                     vector_store_id
-                    <a href="https://platform.openai.com/docs/api-reference/vector-stores/delete#vector-stores-delete-vector_store_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 vector store to delete.</dd>

package/src/videos/help.html

@@ -0,0 +1,113 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">🎬 Videos</summary>
+        <a href="https://developers.openai.com/api/reference/typescript/resources/videos/" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+
+        <h4 style="font-weight: bolder;"> ⋙ List Videos</h4>
+        <p>List generated videos.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt class="optional">
+                after
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Pagination cursor for items after this id.</dd>
+            <dt class="optional">
+                limit
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>Maximum number of videos to return.</dd>
+            <dt class="optional">
+                order
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Sort order by creation time. Use <code>asc</code> or <code>desc</code>.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Create Video</h4>
+        <p>Create a new video generation job.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                prompt
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Prompt describing the video output.</dd>
+            <dt class="optional">
+                input_reference
+                <span class="property-type">file</span>
+            </dt>
+            <dd>Optional reference image upload.</dd>
+            <dt class="optional">
+                model
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Video model id.</dd>
+            <dt class="optional">
+                seconds
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Clip length in seconds.</dd>
+            <dt class="optional">
+                size
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Video resolution.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Video</h4>
+        <p>Retrieve one video job by id.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                video_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The video id.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Delete Video</h4>
+        <p>Delete one video job by id.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                video_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The video id.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Download Video Content</h4>
+        <p>Download rendered video content or related assets.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                video_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The video id.</dd>
+            <dt class="optional">
+                variant
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Asset variant: <code>video</code>, <code>thumbnail</code>, or <code>spritesheet</code>.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Remix Video</h4>
+        <p>Create a remix from an existing video id.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                video_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The source video id.</dd>
+            <dt>
+                prompt
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Prompt describing remix changes.</dd>
+        </dl>
+    </details>
+</section>

package/src/videos/methods.js

@@ -0,0 +1,50 @@
+const OpenAI = require("openai").OpenAI;
+
+async function createVideo(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const response = await openai.videos.create(parameters.payload);
+  return response;
+}
+
+async function getVideo(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { video_id, ...params } = parameters.payload;
+  const response = await openai.videos.retrieve(video_id, params);
+  return response;
+}
+
+async function listVideos(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const list = await openai.videos.list(parameters.payload);
+  return [...list.data];
+}
+
+async function deleteVideo(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { video_id, ...params } = parameters.payload;
+  const response = await openai.videos.delete(video_id, params);
+  return response;
+}
+
+async function downloadVideoContent(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { video_id, ...params } = parameters.payload;
+  const response = await openai.videos.downloadContent(video_id, params);
+  return response;
+}
+
+async function remixVideo(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { video_id, ...body } = parameters.payload;
+  const response = await openai.videos.remix(video_id, body);
+  return response;
+}
+
+module.exports = {
+  createVideo,
+  getVideo,
+  listVideos,
+  deleteVideo,
+  downloadVideoContent,
+  remixVideo,
+};

package/src/videos/template.html

@@ -0,0 +1,8 @@
+<optgroup style="font-style: normal;" label="🎬 Videos">
+    <option value="listVideos" data-i18n="OpenaiApi.parameters.listVideos"></option>
+    <option value="createVideo" data-i18n="OpenaiApi.parameters.createVideo"></option>
+    <option value="getVideo" data-i18n="OpenaiApi.parameters.getVideo"></option>
+    <option value="deleteVideo" data-i18n="OpenaiApi.parameters.deleteVideo"></option>
+    <option value="downloadVideoContent" data-i18n="OpenaiApi.parameters.downloadVideoContent"></option>
+    <option value="remixVideo" data-i18n="OpenaiApi.parameters.remixVideo"></option>
+</optgroup>

package/src/webhooks/help.html

@@ -0,0 +1,61 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">🪝 Webhooks</summary>
+        <a href="https://developers.openai.com/api/reference/typescript/resources/webhooks/" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+
+        <h4 style="font-weight: bolder;"> ⋙ Unwrap Webhook Event</h4>
+        <p>Validate signature and parse the webhook payload into an event object.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                payload
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Raw webhook request body string.</dd>
+            <dt>
+                headers
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Request headers containing webhook signature fields.</dd>
+            <dt class="optional">
+                secret
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Webhook secret. If omitted, SDK-level webhook secret is used.</dd>
+            <dt class="optional">
+                tolerance
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>Maximum webhook age in seconds. Default is <code>300</code>.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Verify Webhook Signature</h4>
+        <p>Validate a webhook signature without parsing the event body.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                payload
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Raw webhook request body string.</dd>
+            <dt>
+                headers
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Request headers containing webhook signature fields.</dd>
+            <dt class="optional">
+                secret
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Webhook secret. If omitted, SDK-level webhook secret is used.</dd>
+            <dt class="optional">
+                tolerance
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>Maximum webhook age in seconds. Default is <code>300</code>.</dd>
+        </dl>
+
+        <p>The verify method returns <code>{ verified: true }</code> on success.</p>
+    </details>
+</section>

package/src/webhooks/methods.js

@@ -0,0 +1,40 @@
+const OpenAI = require("openai").OpenAI;
+
+async function unwrapWebhookEvent(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const {
+    payload: webhookPayload,
+    headers,
+    secret,
+    tolerance,
+  } = parameters.payload;
+  const response = await openai.webhooks.unwrap(
+    webhookPayload,
+    headers,
+    secret,
+    tolerance
+  );
+  return response;
+}
+
+async function verifyWebhookSignature(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const {
+    payload: webhookPayload,
+    headers,
+    secret,
+    tolerance,
+  } = parameters.payload;
+  await openai.webhooks.verifySignature(
+    webhookPayload,
+    headers,
+    secret,
+    tolerance
+  );
+  return { verified: true };
+}
+
+module.exports = {
+  unwrapWebhookEvent,
+  verifyWebhookSignature,
+};

package/src/webhooks/template.html

@@ -0,0 +1,4 @@
+<optgroup style="font-style: normal;" label="🪝 Webhooks">
+    <option value="unwrapWebhookEvent" data-i18n="OpenaiApi.parameters.unwrapWebhookEvent"></option>
+    <option value="verifyWebhookSignature" data-i18n="OpenaiApi.parameters.verifyWebhookSignature"></option>
+</optgroup>