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

package/src/container-files/help.html

@@ -1,7 +1,7 @@
 <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
+        <a href="https://developers.openai.com/api/reference/typescript/resources/containers/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>
@@ -11,24 +11,18 @@
 
             <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>
@@ -41,32 +35,24 @@
 
             <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>
@@ -79,16 +65,12 @@
 
             <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>
@@ -101,16 +83,12 @@
 
             <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>
@@ -124,16 +102,12 @@
 
             <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>

package/src/containers/help.html

@@ -1,7 +1,7 @@
 <section>
     <details>
         <summary style="font-weight: bold;">🫙 Containers</summary>
-        <a href="https://platform.openai.com/docs/api-reference/containers" target="_blank">Official Documentation
+        <a href="https://developers.openai.com/api/reference/typescript/resources/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>
@@ -11,27 +11,27 @@
 
             <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>
+
+            <dt class="optional">
+                network_policy
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Network policy settings for the container, such as allowlist mode and allowed domains.</dd>
         </dl>
 
         <h4 style="font-weight: bolder;"> ⋙ List Containers</h4>
@@ -41,24 +41,18 @@
 
             <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>
@@ -71,8 +65,6 @@
 
             <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>
@@ -85,12 +77,10 @@
 
             <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>
+</section>

package/src/conversations/help.html

@@ -0,0 +1,135 @@
+<section>
+    <details>
+        <summary style="font-weight: bold;">💬 Conversations</summary>
+        <a href="https://developers.openai.com/api/reference/typescript/resources/conversations/" target="_blank">Official Documentation
+            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
+
+        <h4 style="font-weight: bolder;"> ⋙ Create Conversation</h4>
+        <p>Create a new conversation.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt class="optional">
+                items
+                <span class="property-type">array</span>
+            </dt>
+            <dd>Optional initial conversation items.</dd>
+            <dt class="optional">
+                metadata
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Optional key-value metadata for the conversation.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Conversation</h4>
+        <p>Retrieve a conversation by id.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                conversation_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The conversation id.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Modify Conversation</h4>
+        <p>Update a conversation by id.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                conversation_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The conversation id.</dd>
+            <dt class="optional">
+                metadata
+                <span class="property-type">object</span>
+            </dt>
+            <dd>Metadata to set on the conversation.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Delete Conversation</h4>
+        <p>Delete a conversation by id.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                conversation_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The conversation id.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Create Conversation Item</h4>
+        <p>Add an item to a conversation.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                conversation_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The conversation id.</dd>
+            <dt>
+                item
+                <span class="property-type">object</span>
+            </dt>
+            <dd>The item payload to append.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Retrieve Conversation Item</h4>
+        <p>Retrieve a single conversation item by id.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                conversation_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The conversation id.</dd>
+            <dt>
+                item_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The item id.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ List Conversation Items</h4>
+        <p>List items for a conversation.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                conversation_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The conversation id.</dd>
+            <dt class="optional">
+                after
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Pagination cursor to return items after this item id.</dd>
+            <dt class="optional">
+                limit
+                <span class="property-type">integer</span>
+            </dt>
+            <dd>Maximum number of items to return.</dd>
+            <dt class="optional">
+                order
+                <span class="property-type">string</span>
+            </dt>
+            <dd>Sort order, typically <code>asc</code> or <code>desc</code>.</dd>
+        </dl>
+
+        <h4 style="font-weight: bolder;"> ⋙ Delete Conversation Item</h4>
+        <p>Delete a single conversation item by id.</p>
+        <dl class="message-properties">
+            <h4>msg.payload Properties</h4>
+            <dt>
+                conversation_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The conversation id.</dd>
+            <dt>
+                item_id
+                <span class="property-type">string</span>
+            </dt>
+            <dd>The item id.</dd>
+        </dl>
+    </details>
+</section>

package/src/conversations/methods.js

@@ -0,0 +1,73 @@
+const OpenAI = require("openai").OpenAI;
+
+async function createConversation(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const response = await openai.conversations.create(parameters.payload);
+  return response;
+}
+
+async function getConversation(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { conversation_id, ...params } = parameters.payload;
+  const response = await openai.conversations.retrieve(conversation_id, params);
+  return response;
+}
+
+async function modifyConversation(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { conversation_id, ...body } = parameters.payload;
+  const response = await openai.conversations.update(conversation_id, body);
+  return response;
+}
+
+async function deleteConversation(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { conversation_id, ...params } = parameters.payload;
+  const response = await openai.conversations.delete(conversation_id, params);
+  return response;
+}
+
+async function createConversationItem(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { conversation_id, ...body } = parameters.payload;
+  const response = await openai.conversations.items.create(conversation_id, body);
+  return response;
+}
+
+async function getConversationItem(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { conversation_id, item_id, ...params } = parameters.payload;
+  const response = await openai.conversations.items.retrieve(item_id, {
+    conversation_id,
+    ...params,
+  });
+  return response;
+}
+
+async function listConversationItems(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { conversation_id, ...params } = parameters.payload;
+  const list = await openai.conversations.items.list(conversation_id, params);
+  return [...list.data];
+}
+
+async function deleteConversationItem(parameters) {
+  const openai = new OpenAI(this.clientParams);
+  const { conversation_id, item_id, ...params } = parameters.payload;
+  const response = await openai.conversations.items.delete(item_id, {
+    conversation_id,
+    ...params,
+  });
+  return response;
+}
+
+module.exports = {
+  createConversation,
+  getConversation,
+  modifyConversation,
+  deleteConversation,
+  createConversationItem,
+  getConversationItem,
+  listConversationItems,
+  deleteConversationItem,
+};

package/src/conversations/template.html

@@ -0,0 +1,10 @@
+<optgroup style="font-style: normal;" label="💬 Conversations">
+    <option value="createConversation" data-i18n="OpenaiApi.parameters.createConversation"></option>
+    <option value="getConversation" data-i18n="OpenaiApi.parameters.getConversation"></option>
+    <option value="modifyConversation" data-i18n="OpenaiApi.parameters.modifyConversation"></option>
+    <option value="deleteConversation" data-i18n="OpenaiApi.parameters.deleteConversation"></option>
+    <option value="createConversationItem" data-i18n="OpenaiApi.parameters.createConversationItem"></option>
+    <option value="getConversationItem" data-i18n="OpenaiApi.parameters.getConversationItem"></option>
+    <option value="listConversationItems" data-i18n="OpenaiApi.parameters.listConversationItems"></option>
+    <option value="deleteConversationItem" data-i18n="OpenaiApi.parameters.deleteConversationItem"></option>
+</optgroup>

package/src/embeddings/help.html

@@ -1,7 +1,7 @@
 <section>
     <details>
         <summary style="font-weight: bold;">🔗 Embeddings</summary>
-        <a href="https://platform.openai.com/docs/api-reference/embeddings" target="_blank">Official Documentation
+        <a href="https://developers.openai.com/api/reference/typescript/resources/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>
@@ -10,22 +10,16 @@
 
             <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>
@@ -33,8 +27,6 @@
             </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>
@@ -43,8 +35,6 @@
             </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>