@inductiv/node-red-openai-api 0.3.8 → 0.4.0

package/README.md

@@ -9,6 +9,20 @@
 
 _@inductiv/node-red-openai-api_ offers a versatile and configurable Node-RED node, designed specifically for seamless integration with OpenAI's advanced platform services. It empowers you to effortlessly connect and orchestrate various OpenAI functionalities, leveraging the full power of Node-RED's sophisticated application nodes. Whether you're aiming to enhance your workflows with cutting-edge AI capabilities or create innovative applications, this node serves as your gateway to harnessing the latest in AI technology from OpenAI, all within the intuitive and flexible environment of Node-RED.
 
+## New in Version 0.4.0
+
+- Simplified file uploads.
+  - The `create file` function is now named `upload file` -- update your nodes accordingly.
+  - You no longer need to manually retrieve files in your flow using extra nodes (function, read file, etc.). The `upload file` function now accepts your desired file's absolute path as the `msg.payload.file` value.
+  - See the following updated examples (located in the `examples` directory) for more:
+    - Files
+    - Audio
+    - Images
+    - Assistants
+- Reliability improvements.
+- Now has full OpenAI Node.js package spec parity.
+- Bug fixes.
+
 ## Key Features
 
 - **Seamless Integration**: Directly connect with OpenAI services without the hassle of complex coding or setup.

package/examples/assistants.json

@@ -2,7 +2,7 @@
     {
         "id": "78b174792ca9efaf",
         "type": "tab",
-        "label": "Assistants Example",
+        "label": "Assistants Examples",
         "disabled": false,
         "info": "",
         "env": []
@@ -33,7 +33,7 @@
         ],
         "x": 94,
         "y": 113,
-        "w": 1492,
+        "w": 1472,
         "h": 374
     },
     {
@@ -51,16 +51,15 @@
             "color": "#a4a4a4"
         },
         "nodes": [
-            "e6cb8abd4fe85ef3",
             "7a825447030eb842",
             "e78656f2a1db4141",
-            "50dc0daeab93f1d7",
             "a342bcf840361d49",
-            "da5c242d75d45b1a"
+            "da5c242d75d45b1a",
+            "faf6244b17ba1131"
         ],
         "x": 454,
         "y": 139,
-        "w": 912,
+        "w": 832,
         "h": 122
     },
     {
@@ -78,8 +77,8 @@
             "color": "#a4a4a4"
         },
         "nodes": [
-            "43d56c48fd18dd0b",
-            "d0ed57739e76eba4"
+            "d0ed57739e76eba4",
+            "a319c0690ad183bc"
         ],
         "x": 454,
         "y": 339,
@@ -96,8 +95,8 @@
         "tosidebar": true,
         "console": false,
         "tostatus": false,
-        "complete": "true",
-        "targetType": "full",
+        "complete": "payload",
+        "targetType": "msg",
         "statusVal": "",
         "statusType": "auto",
         "x": 760,
@@ -120,12 +119,12 @@
             },
             {
                 "p": "assistant.name",
-                "v": "My Node-RED Assistant",
+                "v": "_node-red-openai-api-rag-example_",
                 "vt": "str"
             },
             {
                 "p": "assistant.model",
-                "v": "gpt-4-1106-preview",
+                "v": "gpt-3.5-turbo-1106",
                 "vt": "str"
             },
             {
@@ -149,7 +148,7 @@
         "once": false,
         "onceDelay": 0.1,
         "topic": "retrieval",
-        "payload": "[\"/path/to/my_file_1.pdf\",\"/path/to/my_file_2.txt\"]",
+        "payload": "[\"/path/to/my/file-1.txt\",\"/path/to/my/file-2.txt\"]",
         "payloadType": "json",
         "x": 220,
         "y": 220,
@@ -187,7 +186,7 @@
                 "7a825447030eb842"
             ],
             [
-                "43d56c48fd18dd0b"
+                "a319c0690ad183bc"
             ]
         ],
         "outputLabels": [
@@ -200,9 +199,9 @@
         "type": "comment",
         "z": "78b174792ca9efaf",
         "g": "3aed22e8a8626b49",
-        "name": "Document-Enhanced Assistant",
+        "name": "Document-Enhanced (RAG) Assistant",
         "info": "",
-        "x": 250,
+        "x": 270,
         "y": 180,
         "wires": []
     },
@@ -215,7 +214,7 @@
         "props": [
             {
                 "p": "payload.name",
-                "v": "My Node-RED Standard Assistant",
+                "v": "_node-red-openai-api-example_",
                 "vt": "str"
             },
             {
@@ -257,19 +256,19 @@
         "type": "function",
         "z": "78b174792ca9efaf",
         "g": "3aed22e8a8626b49",
-        "name": "structure assistant",
-        "func": "// create an array of IDs from the fil upload response.\nconst file_ids = msg.payload.map(element => element.id);\n\n// attach the file IDs to the assistant.\nmsg.assistant.file_ids = file_ids;\n\nmsg.payload = msg.assistant;\n\n// discard the temporary assistant object.\ndelete msg.assistant;\n\nreturn msg;",
+        "name": "structure assistant payload",
+        "func": "// create an array of IDs from the fil upload response.\nconst file_ids = msg.payload.map(element => element.id);\n\n// attach the file IDs to the assistant.\nmsg.assistant.file_ids = file_ids;\n\nmsg.payload = msg.assistant;\n\nreturn msg;",
         "outputs": 1,
         "timeout": 0,
         "noerr": 0,
         "initialize": "",
         "finalize": "",
         "libs": [],
-        "x": 1470,
+        "x": 1420,
         "y": 220,
         "wires": [
             [
-                "43d56c48fd18dd0b"
+                "a319c0690ad183bc"
             ]
         ]
     },
@@ -284,44 +283,23 @@
         "y": 420,
         "wires": []
     },
-    {
-        "id": "e6cb8abd4fe85ef3",
-        "type": "file in",
-        "z": "78b174792ca9efaf",
-        "g": "6ada9879e91ef156",
-        "name": "read file",
-        "filename": "payload",
-        "filenameType": "msg",
-        "format": "",
-        "chunk": false,
-        "sendError": false,
-        "encoding": "none",
-        "allProps": false,
-        "x": 740,
-        "y": 220,
-        "wires": [
-            [
-                "da5c242d75d45b1a"
-            ]
-        ]
-    },
     {
         "id": "7a825447030eb842",
         "type": "split",
         "z": "78b174792ca9efaf",
         "g": "6ada9879e91ef156",
-        "name": "get file names",
+        "name": "gather file details",
         "splt": "\\n",
         "spltType": "str",
         "arraySplt": 1,
         "arraySpltType": "len",
         "stream": false,
         "addname": "",
-        "x": 560,
+        "x": 570,
         "y": 220,
         "wires": [
             [
-                "e6cb8abd4fe85ef3"
+                "da5c242d75d45b1a"
             ]
         ]
     },
@@ -330,7 +308,7 @@
         "type": "join",
         "z": "78b174792ca9efaf",
         "g": "6ada9879e91ef156",
-        "name": "gather file ids",
+        "name": "gather files",
         "mode": "auto",
         "build": "object",
         "property": "payload",
@@ -346,7 +324,7 @@
         "reduceInit": "",
         "reduceInitType": "",
         "reduceFixup": "",
-        "x": 1270,
+        "x": 1190,
         "y": 220,
         "wires": [
             [
@@ -354,22 +332,6 @@
             ]
         ]
     },
-    {
-        "id": "50dc0daeab93f1d7",
-        "type": "OpenAI API",
-        "z": "78b174792ca9efaf",
-        "g": "6ada9879e91ef156",
-        "name": "upload files",
-        "service": "808a04cb8707d787",
-        "method": "createFile",
-        "x": 1090,
-        "y": 220,
-        "wires": [
-            [
-                "e78656f2a1db4141"
-            ]
-        ]
-    },
     {
         "id": "a342bcf840361d49",
         "type": "comment",
@@ -386,7 +348,7 @@
         "type": "function",
         "z": "78b174792ca9efaf",
         "g": "6ada9879e91ef156",
-        "name": "structure file",
+        "name": "structure file payload",
         "func": "msg.payload = {\n    \"file\": msg.payload,\n    \"purpose\": \"assistants\",\n    \"filename\": msg.filename\n};\nreturn msg;",
         "outputs": 1,
         "timeout": 0,
@@ -394,27 +356,11 @@
         "initialize": "",
         "finalize": "",
         "libs": [],
-        "x": 910,
+        "x": 800,
         "y": 220,
         "wires": [
             [
-                "50dc0daeab93f1d7"
-            ]
-        ]
-    },
-    {
-        "id": "43d56c48fd18dd0b",
-        "type": "OpenAI API",
-        "z": "78b174792ca9efaf",
-        "g": "a08cc5475a20cc70",
-        "name": "create assistant",
-        "service": "39eba92e93450944",
-        "method": "createAssistant",
-        "x": 560,
-        "y": 380,
-        "wires": [
-            [
-                "a1dd9dd38256bc37"
+                "faf6244b17ba1131"
             ]
         ]
     },
@@ -438,5 +384,37 @@
         "x": 180,
         "y": 80,
         "wires": []
+    },
+    {
+        "id": "faf6244b17ba1131",
+        "type": "OpenAI API",
+        "z": "78b174792ca9efaf",
+        "g": "6ada9879e91ef156",
+        "name": "upload file",
+        "service": "",
+        "method": "createFile",
+        "x": 1010,
+        "y": 220,
+        "wires": [
+            [
+                "e78656f2a1db4141"
+            ]
+        ]
+    },
+    {
+        "id": "a319c0690ad183bc",
+        "type": "OpenAI API",
+        "z": "78b174792ca9efaf",
+        "g": "a08cc5475a20cc70",
+        "name": "create assistant",
+        "service": "",
+        "method": "createAssistant",
+        "x": 560,
+        "y": 380,
+        "wires": [
+            [
+                "a1dd9dd38256bc37"
+            ]
+        ]
     }
 ]

package/examples/audio.json

@@ -1,25 +1,75 @@
 [
     {
-        "id": "a8f46f8122644718",
+        "id": "8a949045c2bde44f",
         "type": "tab",
-        "label": "Audio Example",
+        "label": "Audio Examples",
         "disabled": false,
         "info": "",
         "env": []
     },
     {
-        "id": "467ebc87b8844787",
+        "id": "cfc4e326cf246fe9",
+        "type": "group",
+        "z": "8a949045c2bde44f",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "fe06a0eb68e7942b",
+            "dfaea51753a120f1",
+            "3bf87f7cccba7d76",
+            "378ed95ad08397c6"
+        ],
+        "x": 154,
+        "y": 139,
+        "w": 572,
+        "h": 142
+    },
+    {
+        "id": "3b463393064f49b9",
+        "type": "group",
+        "z": "8a949045c2bde44f",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "adbe3dd2124bd65e",
+            "254e24ddcedb56fb",
+            "ea94f3df99cb5ad9",
+            "c870615f02a9f85e",
+            "c09d2cb245a00b1d"
+        ],
+        "x": 154,
+        "y": 339,
+        "w": 752,
+        "h": 142
+    },
+    {
+        "id": "fe06a0eb68e7942b",
         "type": "inject",
-        "z": "a8f46f8122644718",
-        "name": "translation payload",
+        "z": "8a949045c2bde44f",
+        "g": "cfc4e326cf246fe9",
+        "name": "request",
         "props": [
             {
-                "p": "filename",
-                "v": "/path/to/my_file.mp3",
+                "p": "payload.file",
+                "v": "/path/to/my/input-file.mp3",
                 "vt": "str"
             },
             {
-                "p": "model",
+                "p": "payload.model",
                 "v": "whisper-1",
                 "vt": "str"
             }
@@ -29,94 +79,163 @@
         "once": false,
         "onceDelay": 0.1,
         "topic": "",
-        "x": 190,
-        "y": 260,
+        "x": 250,
+        "y": 240,
+        "wires": [
+            [
+                "378ed95ad08397c6"
+            ]
+        ]
+    },
+    {
+        "id": "dfaea51753a120f1",
+        "type": "debug",
+        "z": "8a949045c2bde44f",
+        "g": "cfc4e326cf246fe9",
+        "name": "Response",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 620,
+        "y": 240,
+        "wires": []
+    },
+    {
+        "id": "3bf87f7cccba7d76",
+        "type": "comment",
+        "z": "8a949045c2bde44f",
+        "g": "cfc4e326cf246fe9",
+        "name": "Create Translation",
+        "info": "",
+        "x": 270,
+        "y": 180,
+        "wires": []
+    },
+    {
+        "id": "adbe3dd2124bd65e",
+        "type": "inject",
+        "z": "8a949045c2bde44f",
+        "g": "3b463393064f49b9",
+        "name": "request",
+        "props": [
+            {
+                "p": "payload.model",
+                "v": "tts-1",
+                "vt": "str"
+            },
+            {
+                "p": "payload.input",
+                "v": "Hello world!",
+                "vt": "str"
+            },
+            {
+                "p": "payload.voice",
+                "v": "onyx",
+                "vt": "str"
+            },
+            {
+                "p": "filename",
+                "v": "/path/to/my/output-file.mp3",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 250,
+        "y": 440,
         "wires": [
             [
-                "3a737dfa6879caa2"
+                "c870615f02a9f85e"
             ]
         ]
     },
     {
-        "id": "72303cea19bd9de9",
+        "id": "378ed95ad08397c6",
         "type": "OpenAI API",
-        "z": "a8f46f8122644718",
-        "name": "translator",
-        "service": "808a04cb8707d787",
+        "z": "8a949045c2bde44f",
+        "g": "cfc4e326cf246fe9",
+        "name": "Create Translation",
+        "service": "",
         "method": "createTranslation",
-        "x": 760,
-        "y": 260,
+        "x": 430,
+        "y": 240,
         "wires": [
             [
-                "b6fdacab7fb309bd"
+                "dfaea51753a120f1"
             ]
         ]
     },
     {
-        "id": "b6fdacab7fb309bd",
+        "id": "254e24ddcedb56fb",
+        "type": "file",
+        "z": "8a949045c2bde44f",
+        "g": "3b463393064f49b9",
+        "name": "save audio file",
+        "filename": "filename",
+        "filenameType": "msg",
+        "appendNewline": false,
+        "createDir": false,
+        "overwriteFile": "true",
+        "encoding": "none",
+        "x": 620,
+        "y": 440,
+        "wires": [
+            [
+                "ea94f3df99cb5ad9"
+            ]
+        ]
+    },
+    {
+        "id": "ea94f3df99cb5ad9",
         "type": "debug",
-        "z": "a8f46f8122644718",
+        "z": "8a949045c2bde44f",
+        "g": "3b463393064f49b9",
         "name": "response",
         "active": true,
         "tosidebar": true,
         "console": false,
         "tostatus": false,
-        "complete": "payload",
-        "targetType": "msg",
+        "complete": "true",
+        "targetType": "full",
         "statusVal": "",
         "statusType": "auto",
-        "x": 920,
-        "y": 260,
+        "x": 800,
+        "y": 440,
         "wires": []
     },
     {
-        "id": "3a737dfa6879caa2",
-        "type": "file in",
-        "z": "a8f46f8122644718",
-        "name": "audio file",
-        "filename": "filename",
-        "filenameType": "msg",
-        "format": "",
-        "chunk": false,
-        "sendError": false,
-        "encoding": "utf-16be",
-        "allProps": false,
-        "x": 380,
-        "y": 260,
+        "id": "c870615f02a9f85e",
+        "type": "OpenAI API",
+        "z": "8a949045c2bde44f",
+        "g": "3b463393064f49b9",
+        "name": "create speech",
+        "service": "",
+        "method": "createSpeech",
+        "x": 420,
+        "y": 440,
         "wires": [
             [
-                "6e882571ec7d2180"
+                "254e24ddcedb56fb"
             ]
         ]
     },
     {
-        "id": "4a3af447f46156b8",
+        "id": "c09d2cb245a00b1d",
         "type": "comment",
-        "z": "a8f46f8122644718",
-        "name": "Audio Translation",
+        "z": "8a949045c2bde44f",
+        "g": "3b463393064f49b9",
+        "name": "Create Speech",
         "info": "",
-        "x": 160,
-        "y": 220,
+        "x": 260,
+        "y": 380,
         "wires": []
-    },
-    {
-        "id": "6e882571ec7d2180",
-        "type": "function",
-        "z": "a8f46f8122644718",
-        "name": "structure payload",
-        "func": "let newPayload = {};\n\nnewPayload.file = msg.payload;\nnewPayload.model = msg.model;\nnewPayload.filename = msg.filename;\n\nmsg.payload = newPayload;\n\ndelete msg.model;\ndelete msg.filename;\n\nreturn msg;",
-        "outputs": 1,
-        "timeout": 0,
-        "noerr": 0,
-        "initialize": "",
-        "finalize": "",
-        "libs": [],
-        "x": 570,
-        "y": 260,
-        "wires": [
-            [
-                "72303cea19bd9de9"
-            ]
-        ]
     }
 ]