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

package/src/container-files/help.html

@@ -0,0 +1,144 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">🗄️ Container Files</summary>
+        <a href="https://platform.openai.com/docs/api-reference/container-files" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+
+        <h4 style="font-weight: bolder;"> ⋙ Create Container File</h4>
+        <p>Create a container file.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                container_id
+                <a href="https://platform.openai.com/docs/api-reference/container-files/createContainerFile#container-files-createcontainerfile-container_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 container to hold the file.</dd>
+
+            <dt class="optional">
+                file
+                <a href="https://platform.openai.com/docs/api-reference/container-files/createContainerFile#container-files-createcontainerfile-file"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">file</span>
+            </dt>
+            <dd>The File object (not file name) to be uploaded.</dd>
+
+            <dt class="optional">
+                file_id
+                <a href="https://platform.openai.com/docs/api-reference/container-files/createContainerFile#container-files-createcontainerfile-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>Name of the file to create.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ List Container Files</h4>
+        <p>List container files.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                container_id
+                <a href="https://platform.openai.com/docs/api-reference/container-files/listContainerFiles#container-files-listcontainerfiles-container_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 desired container.</dd>
+
+            <dt class="optional">
+                after
+                <a href="https://platform.openai.com/docs/api-reference/container-files/listContainerFiles#container-files-listcontainerfiles-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/container-files/listContainerFiles#container-files-listcontainerfiles-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.</dd>
+
+            <dt class="optional">
+                order
+                <a href="https://platform.openai.com/docs/api-reference/container-files/listContainerFiles#container-files-listcontainerfiles-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>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Container File</h4>
+        <p>Retrieve a container file.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                container_id
+                <a href="https://platform.openai.com/docs/api-reference/container-files/retrieveContainerFile#container-files-retrievecontainerfile-container_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 desired container.</dd>
+
+            <dt>
+                file_id
+                <a href="https://platform.openai.com/docs/api-reference/container-files/retrieveContainerFile#container-files-retrievecontainerfile-container_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 retrieve.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Container File Content</h4>
+        <p>Retrieves container file content.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                container_id
+                <a href="https://platform.openai.com/docs/api-reference/container-files/retrieveContainerFileContent#container-files-retrievecontainerfilecontent-container_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 desired container.</dd>
+
+            <dt>
+                file_id
+                <a href="https://platform.openai.com/docs/api-reference/container-files/retrieveContainerFileContent#container-files-retrievecontainerfilecontent-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 desired file.</dd>
+
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Delete Container File</h4>
+        <p>Deletes a container file.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                container_id
+                <a href="https://platform.openai.com/docs/api-reference/container-files/deleteContainerFile#container-files-deletecontainerfile-container_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 desired container.</dd>
+
+            <dt>
+                file_id
+                <a href="https://platform.openai.com/docs/api-reference/container-files/deleteContainerFile#container-files-deletecontainerfile-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 delete.</dd>
+
+        </dl>
+
+    </details>
+</section>

package/src/container-files/methods.js

@@ -0,0 +1,60 @@
+const OpenAI = require("openai").OpenAI;
+const fs = require("fs");
+
+async function listContainerFiles(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { container_id, ...params } = parameters.payload;
+  const list = await openai.containers.files.list(container_id, params);
+  return [...list.data];
+}
+
+async function addContainerFile(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  let { container_id, file, ...params } = parameters.payload;
+  if (file) {
+    params.file = fs.createReadStream(file);
+  }
+  const response = await openai.containers.files.create(container_id, params);
+  return response;
+}
+
+async function retrieveContainerFile(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { container_id, file_id, ...params } = parameters.payload;
+  const response = await openai.containers.files.retrieve(
+    container_id,
+    file_id,
+    params
+  );
+  return response;
+}
+
+async function deleteContainerFile(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { container_id, file_id, ...params } = parameters.payload;
+  const response = await openai.containers.files.del(
+    container_id,
+    file_id,
+    params
+  );
+  return response;
+}
+
+async function downloadContainerFileContent(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { container_id, file_id, ...params } = parameters.payload;
+  const response = await openai.containers.files.content.retrieve(
+    container_id,
+    file_id,
+    params
+  );
+  return response;
+}
+
+module.exports = {
+  listContainerFiles,
+  addContainerFile,
+  retrieveContainerFile,
+  deleteContainerFile,
+  downloadContainerFileContent,
+};

package/src/container-files/template.html

@@ -0,0 +1,7 @@
+<optgroup style="font-style: normal;" label="🗄️ Container Files">
+    <option value="listContainerFiles" data-i18n="OpenaiApi.parameters.listContainerFiles"></option>
+    <option value="addContainerFile" data-i18n="OpenaiApi.parameters.addContainerFile"></option>
+    <option value="retrieveContainerFile" data-i18n="OpenaiApi.parameters.retrieveContainerFile"></option>
+    <option value="deleteContainerFile" data-i18n="OpenaiApi.parameters.deleteContainerFile"></option>
+    <option value="downloadContainerFileContent" data-i18n="OpenaiApi.parameters.downloadContainerFileContent"></option>
+</optgroup>

package/src/containers/help.html

@@ -0,0 +1,96 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">🫙 Containers</summary>
+        <a href="https://platform.openai.com/docs/api-reference/containers" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+
+        <h4 style="font-weight: bolder;"> ⋙ Create Container</h4>
+        <p>Create and manage containers for use with the Code Interpreter tool.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                name
+                <a href="https://platform.openai.com/docs/api-reference/containers/createContainers#containers-createcontainers-name"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Name of the container to create.</dd>
+
+            <dt class="optional">
+                expires_after
+                <a href="https://platform.openai.com/docs/api-reference/containers/createContainers#containers-createcontainers-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>Container expiration time in seconds relative to the 'anchor' time.</dd>
+
+            <dt class="optional">
+                file_ids
+                <a href="https://platform.openai.com/docs/api-reference/containers/createContainers#containers-createcontainers-file_ids"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">array</span>
+            </dt>
+            <dd>IDs of files to copy to the container.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ List Containers</h4>
+        <p>List Containers</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt class="optional">
+                after
+                <a href="https://platform.openai.com/docs/api-reference/containers/listContainers#containers-listcontainers-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/containers/listContainers#containers-listcontainers-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.</dd>
+
+            <dt class="optional">
+                order
+                <a href="https://platform.openai.com/docs/api-reference/containers/listContainers#containers-listcontainers-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>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Container</h4>
+        <p>Retrieve container.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                container_id
+                <a href="https://platform.openai.com/docs/api-reference/containers/retrieveContainer#containers-retrievecontainer-container_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 container to retrieve.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Delete Container</h4>
+        <p>Delete container.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                container_id
+                <a href="https://platform.openai.com/docs/api-reference/containers/deleteContainer#containers-deletecontainer-container_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 container to delete.</dd>
+        </dl>
+
+    </details>
+</section>

package/src/containers/methods.js

@@ -0,0 +1,34 @@
+const OpenAI = require("openai").OpenAI;
+
+async function listContainers(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const list = await openai.containers.list(parameters.payload);
+  return [...list.data];
+}
+
+async function createContainer(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const response = await openai.containers.create(parameters.payload);
+  return response;
+}
+
+async function retrieveContainer(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { container_id, ...params } = parameters.payload;
+  const response = await openai.containers.retrieve(container_id, params);
+  return response;
+}
+
+async function deleteContainer(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { container_id, ...params } = parameters.payload;
+  const response = await openai.containers.del(container_id, params);
+  return response;
+}
+
+module.exports = {
+  createContainer,
+  listContainers,
+  retrieveContainer,
+  deleteContainer,
+};

package/src/containers/template.html

@@ -0,0 +1,6 @@
+<optgroup style="font-style: normal;" label="🫙 Containers">
+    <option value="listContainers" data-i18n="OpenaiApi.parameters.listContainers"></option>
+    <option value="createContainer" data-i18n="OpenaiApi.parameters.createContainer"></option>
+    <option value="retrieveContainer" data-i18n="OpenaiApi.parameters.retrieveContainer"></option>
+    <option value="deleteContainer" data-i18n="OpenaiApi.parameters.deleteContainer"></option>
+</optgroup>

package/src/embeddings/help.html

@@ -0,0 +1,57 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">🔗 Embeddings</summary>
+        <a href="https://platform.openai.com/docs/api-reference/embeddings" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+        <h4 style="font-weight: bolder;"> ⋙ Create Embeddings</h4>
+        <p>Creates an embedding vector representing the input text.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                input
+                <a href="https://platform.openai.com/docs/api-reference/embeddings/create#embeddings-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>Input text to embed, encoded as a string or array of tokens.</dd>
+            <dt>
+                model
+                <a href="https://platform.openai.com/docs/api-reference/embeddings/create#embeddings-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>ID of the model to use.</dd>
+            <dt class="optional">
+                encoding_format
+                <a href="https://platform.openai.com/docs/api-reference/embeddings/create#embeddings-create-encoding_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 return the embeddings in. Can be either float or base64.
+            </dd>
+            <dt class="optional">
+                dimensions
+                <a href="https://platform.openai.com/docs/api-reference/embeddings/create#embeddings-create-dimensions"
+                    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 dimensions the resulting output embeddings should have.
+                Only supported in text-embedding-3 and later models.
+            </dd>
+            <dt class="optional">
+                user
+                <a href="https://platform.openai.com/docs/api-reference/embeddings/create#embeddings-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>
+
+    </details>
+</section>

package/src/embeddings/methods.js

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

package/src/embeddings/template.html

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

package/src/files/help.html

@@ -0,0 +1,102 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">📁 Files</summary>
+        <a href="https://platform.openai.com/docs/api-reference/files" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+        <h4 style="font-weight: bolder;"> ⋙ List Files</h4>
+        <p>Returns a list of files that belong to the user's organization.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt class="optional">
+                purpose
+                <a href="https://platform.openai.com/docs/api-reference/files/list#files-list-purpose"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Only return files with the given purpose.</dd>
+
+            <dt class="optional">
+                limit
+                <a href="https://platform.openai.com/docs/api-reference/files/list#files-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.</dd>
+
+            <dt class="optional">
+                order
+                <a href="https://platform.openai.com/docs/api-reference/files/list#files-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.</dd>
+
+            <dt class="optional">
+                after
+                <a href="https://platform.openai.com/docs/api-reference/files/list#files-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.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Upload File</h4>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                file
+                <a href="https://platform.openai.com/docs/api-reference/files/create#files-create-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 uploaded.</dd>
+            <dt>
+                purpose
+                <a href="https://platform.openai.com/docs/api-reference/files/create#files-create-purpose"
+                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The intended purpose of the uploaded file.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Delete File</h4>
+        <p>Delete a file.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>file_id <span class="property-type">string</span></dt>
+            <dd>The ID of the file to use for this request.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve File</h4>
+        <p>Returns information about a specific file.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                file_id
+                <a href="https://platform.openai.com/docs/api-reference/files/delete#files-delete-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 use for this request.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve File Content</h4>
+        <p>Returns the contents of the specified file.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+
+            <dt>
+                file_id
+                <a href="https://platform.openai.com/docs/api-reference/files/retrieve-contents#files-retrieve-contents-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 use for this request.</dd>
+        </dl>
+
+    </details>
+</section>

package/src/files/methods.js

@@ -0,0 +1,52 @@
+const OpenAI = require("openai").OpenAI;
+const fs = require("fs");
+
+async function listFiles(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const list = await openai.files.list(parameters.payload);
+
+  return [...list.data];
+}
+
+async function createFile(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  let { file, ...params } = parameters.payload;
+
+  params.file = fs.createReadStream(file);
+
+  const response = await openai.files.create(params);
+
+  return response;
+}
+
+async function deleteFile(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { file_id, ...params } = parameters.payload;
+  const response = await openai.files.del(file_id, params);
+
+  return response;
+}
+
+async function retrieveFile(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { file_id, ...params } = parameters.payload;
+  const response = await openai.files.retrieve(file_id, params);
+
+  return response;
+}
+
+async function downloadFile(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { file_id, ...params } = parameters.payload;
+  const response = await openai.files.content(file_id, params);
+
+  return response;
+}
+
+module.exports = {
+  listFiles,
+  createFile,
+  deleteFile,
+  retrieveFile,
+  downloadFile,
+};

package/src/files/template.html

@@ -0,0 +1,22 @@
+      <optgroup style="font-style: normal;" label="📁 Files">
+        <option
+          value="listFiles"
+          data-i18n="OpenaiApi.parameters.listFiles"
+        ></option>
+        <option
+          value="createFile"
+          data-i18n="OpenaiApi.parameters.uploadFile"
+        ></option>
+        <option
+          value="deleteFile"
+          data-i18n="OpenaiApi.parameters.deleteFile"
+        ></option>
+        <option
+          value="retrieveFile"
+          data-i18n="OpenaiApi.parameters.retrieveFile"
+        ></option>
+        <option
+          value="downloadFile"
+          data-i18n="OpenaiApi.parameters.downloadFile"
+        ></option>
+      </optgroup>