@inductiv/node-red-openai-api 0.1.0

package/LICENSE

@@ -0,0 +1,7 @@
+# Copyright 2023 Allan Bunch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,66 @@
+<h1 align="center">
+  Low-code AI for Innovators with Deadlines
+  <br>
+<a href="https://github.com/allanbunch/node-red-openai-api"> <img width="923" alt="assistants-example" src="https://github.com/allanbunch/node-red-openai-api/assets/4503640/204dce33-0b9f-4c6a-8665-b1e69dab21b5">
+ </a>
+<br>
+@inductiv/node-red-openai-api
+</h1>
+
+_@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.
+
+## Key Features
+
+- **Seamless Integration**: Directly connect with OpenAI services without the hassle of complex coding or setup.
+- **Configurable and Flexible**: Designed for adaptability, this node can be easily configured to suit a wide range of project requirements, streamlining your development workflow.
+- **Powerful Combinations**: Take advantage of Node-RED's diverse nodes to build complex, AI-driven workflows with ease.
+
+Ideal for developers, researchers, and innovators, this node is your tool for unlocking the full potential of AI in your projects.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [License](#license)
+- [Acknowledgements](#acknowledgements)
+
+## Installation
+
+Via the Node-RED Palette Manager, install
+
+```text
+@inductiv/node-red-openai-api
+```
+
+Via NPM
+
+```bash
+cd $HOME/.node-red
+npm i @inductiv/node-red-openai-api
+```
+
+## Usage
+
+Find your _@inductiv/node-red-openai-api_ node in the **AI** palette category.
+
+<img width="122" alt="inductiv-node-red-openai-api-node" src="https://github.com/allanbunch/node-red-openai-api/assets/4503640/55b6528a-0f94-4e24-8c98-f47104624651">
+
+You'll find a set of example implementation flows in the [examples](./examples/) directory.
+
+<img width="722" alt="audio-translation" src="https://github.com/allanbunch/node-red-openai-api/assets/4503640/4f2aa5c2-87a9-4cad-af32-10bca094141c">
+
+Note: Each node's functionality maps to the official OpenAI [API Reference](https://platform.openai.com/docs/api-reference/) documentation.
+
+Node contains inutitive inline help with links to OpenAI's official API documentation.
+
+<img width="619" alt="inductiv-node-red-openai-api-node-config" src="https://github.com/allanbunch/node-red-openai-api/assets/4503640/15ee5b75-2e29-4806-b427-8e6873f3fb96">
+
+## License
+
+[MIT](./LICENSE)
+
+## Acknowledgements
+
+- [node-red-nodegen](https://github.com/node-red/node-red-nodegen)
+  - For boilerplate code generation, though the auto-generated code has been largely refactored.
+  - **Note:** This package uses `axios` in place of node-red-nodegen's `request` default.

package/examples/assistants.json

@@ -0,0 +1,442 @@
+[
+    {
+        "id": "78b174792ca9efaf",
+        "type": "tab",
+        "label": "Assistants Example",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
+    {
+        "id": "3aed22e8a8626b49",
+        "type": "group",
+        "z": "78b174792ca9efaf",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "a1dd9dd38256bc37",
+            "94c58ec5fd3ce89a",
+            "78bae2355d746f5b",
+            "16fd166e2cfe1aec",
+            "54cdefbcbbec117f",
+            "e0007c022bce36b9",
+            "e5b83cdfc84c22f9",
+            "6ada9879e91ef156",
+            "a08cc5475a20cc70"
+        ],
+        "x": 94,
+        "y": 113,
+        "w": 1492,
+        "h": 374
+    },
+    {
+        "id": "6ada9879e91ef156",
+        "type": "group",
+        "z": "78b174792ca9efaf",
+        "g": "3aed22e8a8626b49",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "e6cb8abd4fe85ef3",
+            "7a825447030eb842",
+            "e78656f2a1db4141",
+            "50dc0daeab93f1d7",
+            "a342bcf840361d49",
+            "da5c242d75d45b1a"
+        ],
+        "x": 454,
+        "y": 139,
+        "w": 912,
+        "h": 122
+    },
+    {
+        "id": "a08cc5475a20cc70",
+        "type": "group",
+        "z": "78b174792ca9efaf",
+        "g": "3aed22e8a8626b49",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "43d56c48fd18dd0b",
+            "d0ed57739e76eba4"
+        ],
+        "x": 454,
+        "y": 339,
+        "w": 212,
+        "h": 122
+    },
+    {
+        "id": "a1dd9dd38256bc37",
+        "type": "debug",
+        "z": "78b174792ca9efaf",
+        "g": "3aed22e8a8626b49",
+        "name": "response",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "true",
+        "targetType": "full",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 760,
+        "y": 380,
+        "wires": []
+    },
+    {
+        "id": "94c58ec5fd3ce89a",
+        "type": "inject",
+        "z": "78b174792ca9efaf",
+        "g": "3aed22e8a8626b49",
+        "name": "assistant payload",
+        "props": [
+            {
+                "p": "topic",
+                "vt": "str"
+            },
+            {
+                "p": "payload"
+            },
+            {
+                "p": "assistant.name",
+                "v": "My Node-RED Assistant",
+                "vt": "str"
+            },
+            {
+                "p": "assistant.model",
+                "v": "gpt-4-1106-preview",
+                "vt": "str"
+            },
+            {
+                "p": "assistant.tools",
+                "v": "[{\"type\":\"retrieval\"}]",
+                "vt": "json"
+            },
+            {
+                "p": "assistant.description",
+                "v": "My helpful assistant.",
+                "vt": "str"
+            },
+            {
+                "p": "assistant.instructions",
+                "v": "You are a helpful assistant with access to files that I share with you.",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "retrieval",
+        "payload": "[\"/path/to/my_file_1.pdf\",\"/path/to/my_file_2.txt\"]",
+        "payloadType": "json",
+        "x": 220,
+        "y": 220,
+        "wires": [
+            [
+                "78bae2355d746f5b"
+            ]
+        ]
+    },
+    {
+        "id": "78bae2355d746f5b",
+        "type": "switch",
+        "z": "78b174792ca9efaf",
+        "g": "3aed22e8a8626b49",
+        "name": "assistant type switch",
+        "property": "topic",
+        "propertyType": "msg",
+        "rules": [
+            {
+                "t": "eq",
+                "v": "retrieval",
+                "vt": "str"
+            },
+            {
+                "t": "else"
+            }
+        ],
+        "checkall": "true",
+        "repair": false,
+        "outputs": 2,
+        "x": 300,
+        "y": 300,
+        "wires": [
+            [
+                "7a825447030eb842"
+            ],
+            [
+                "43d56c48fd18dd0b"
+            ]
+        ],
+        "outputLabels": [
+            "Document-enhanced Agent",
+            "Standard Agent"
+        ]
+    },
+    {
+        "id": "16fd166e2cfe1aec",
+        "type": "comment",
+        "z": "78b174792ca9efaf",
+        "g": "3aed22e8a8626b49",
+        "name": "Document-Enhanced Assistant",
+        "info": "",
+        "x": 250,
+        "y": 180,
+        "wires": []
+    },
+    {
+        "id": "54cdefbcbbec117f",
+        "type": "inject",
+        "z": "78b174792ca9efaf",
+        "g": "3aed22e8a8626b49",
+        "name": "assistant payload",
+        "props": [
+            {
+                "p": "payload.name",
+                "v": "My Node-RED Standard Assistant",
+                "vt": "str"
+            },
+            {
+                "p": "payload.model",
+                "v": "gpt-4-1106-preview",
+                "vt": "str"
+            },
+            {
+                "p": "payload.tools",
+                "v": "[{\"type\":\"code_interpreter\"}]",
+                "vt": "json"
+            },
+            {
+                "p": "payload.description",
+                "v": "My helpful standard assistant.",
+                "vt": "str"
+            },
+            {
+                "p": "payload.instructions",
+                "v": "You are a helpful assistant.",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 220,
+        "y": 380,
+        "wires": [
+            [
+                "78bae2355d746f5b"
+            ]
+        ]
+    },
+    {
+        "id": "e0007c022bce36b9",
+        "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;",
+        "outputs": 1,
+        "timeout": 0,
+        "noerr": 0,
+        "initialize": "",
+        "finalize": "",
+        "libs": [],
+        "x": 1470,
+        "y": 220,
+        "wires": [
+            [
+                "43d56c48fd18dd0b"
+            ]
+        ]
+    },
+    {
+        "id": "e5b83cdfc84c22f9",
+        "type": "comment",
+        "z": "78b174792ca9efaf",
+        "g": "3aed22e8a8626b49",
+        "name": "Standard Assistant",
+        "info": "",
+        "x": 210,
+        "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",
+        "splt": "\\n",
+        "spltType": "str",
+        "arraySplt": 1,
+        "arraySpltType": "len",
+        "stream": false,
+        "addname": "",
+        "x": 560,
+        "y": 220,
+        "wires": [
+            [
+                "e6cb8abd4fe85ef3"
+            ]
+        ]
+    },
+    {
+        "id": "e78656f2a1db4141",
+        "type": "join",
+        "z": "78b174792ca9efaf",
+        "g": "6ada9879e91ef156",
+        "name": "gather file ids",
+        "mode": "auto",
+        "build": "object",
+        "property": "payload",
+        "propertyType": "msg",
+        "key": "topic",
+        "joiner": "\\n",
+        "joinerType": "str",
+        "accumulate": true,
+        "timeout": "",
+        "count": "",
+        "reduceRight": false,
+        "reduceExp": "",
+        "reduceInit": "",
+        "reduceInitType": "",
+        "reduceFixup": "",
+        "x": 1270,
+        "y": 220,
+        "wires": [
+            [
+                "e0007c022bce36b9"
+            ]
+        ]
+    },
+    {
+        "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",
+        "z": "78b174792ca9efaf",
+        "g": "6ada9879e91ef156",
+        "name": "Upload Files",
+        "info": "",
+        "x": 550,
+        "y": 180,
+        "wires": []
+    },
+    {
+        "id": "da5c242d75d45b1a",
+        "type": "function",
+        "z": "78b174792ca9efaf",
+        "g": "6ada9879e91ef156",
+        "name": "structure file",
+        "func": "msg.payload = {\n    \"file\": msg.payload,\n    \"purpose\": \"assistants\",\n    \"filename\": msg.filename\n};\nreturn msg;",
+        "outputs": 1,
+        "timeout": 0,
+        "noerr": 0,
+        "initialize": "",
+        "finalize": "",
+        "libs": [],
+        "x": 910,
+        "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"
+            ]
+        ]
+    },
+    {
+        "id": "d0ed57739e76eba4",
+        "type": "comment",
+        "z": "78b174792ca9efaf",
+        "g": "a08cc5475a20cc70",
+        "name": "Create Assistant",
+        "info": "",
+        "x": 560,
+        "y": 420,
+        "wires": []
+    },
+    {
+        "id": "e3812b47c1b7b918",
+        "type": "comment",
+        "z": "78b174792ca9efaf",
+        "name": "Create Assistants",
+        "info": "",
+        "x": 180,
+        "y": 80,
+        "wires": []
+    }
+]

package/examples/audio.json

@@ -0,0 +1,122 @@
+[
+    {
+        "id": "a8f46f8122644718",
+        "type": "tab",
+        "label": "Audio Example",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
+    {
+        "id": "467ebc87b8844787",
+        "type": "inject",
+        "z": "a8f46f8122644718",
+        "name": "translation payload",
+        "props": [
+            {
+                "p": "filename",
+                "v": "/path/to/my_file.mp3",
+                "vt": "str"
+            },
+            {
+                "p": "model",
+                "v": "whisper-1",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 190,
+        "y": 260,
+        "wires": [
+            [
+                "3a737dfa6879caa2"
+            ]
+        ]
+    },
+    {
+        "id": "72303cea19bd9de9",
+        "type": "openai-api",
+        "z": "a8f46f8122644718",
+        "name": "translator",
+        "service": "808a04cb8707d787",
+        "method": "createTranslation",
+        "x": 760,
+        "y": 260,
+        "wires": [
+            [
+                "b6fdacab7fb309bd"
+            ]
+        ]
+    },
+    {
+        "id": "b6fdacab7fb309bd",
+        "type": "debug",
+        "z": "a8f46f8122644718",
+        "name": "response",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 920,
+        "y": 260,
+        "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,
+        "wires": [
+            [
+                "6e882571ec7d2180"
+            ]
+        ]
+    },
+    {
+        "id": "4a3af447f46156b8",
+        "type": "comment",
+        "z": "a8f46f8122644718",
+        "name": "Audio Translation",
+        "info": "",
+        "x": 160,
+        "y": 220,
+        "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"
+            ]
+        ]
+    }
+]