@cpwc/node-red-contrib-ai-intent 3.1.0-alpha

package/openai-response/index.html

@@ -0,0 +1,66 @@
+<script type="text/javascript">
+    RED.nodes.registerType("OpenAI Response", {
+        category: 'AI Intent',
+        color: 'rgba(255, 0, 119, .5)',
+        icon:"font-awesome/fa-commenting-o",
+        defaults: {
+            name: { value: "" },
+            keepFormatting: {value: false},
+            clearConversation: {value: false}
+        },
+        inputs: 1,
+        outputs: 1,
+        paletteLabel: "Response (Deprecated)",
+        label: function () {
+            return this.name ? `${this.name} (Deprecated)` : "Response (Deprecated)";
+        },
+
+        oneditprepare: function(x){
+           
+        }
+    });
+
+</script>
+
+<script type="text/html" data-template-name="OpenAI Response">
+
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+
+    <div style="display: flex; justify-content: space-around;">
+    
+        <label for="node-input-keepFormatting" style="display: flex;">
+            <i class="fa fa-tag"></i>
+            <span style="margin-left: 5px;">Keep Formatting</span>
+            <input style="display: inline-block;margin-left: 1rem;" type="checkbox" id="node-input-keepFormatting"
+                name="keep formatting">
+        </label>
+
+        <label for="node-input-clearConversation" style="display: flex;">
+            <i class="fa fa-tag"></i>
+            <span style="margin-left: 5px;">Clear Conversation</span>
+            <input style="display: inline-block;margin-left: 1rem;" type="checkbox" id="node-input-clearConversation"
+                name="removes the conversation from context">
+        </label>
+    </div>
+</script>
+
+<script type="text/html" data-help-name="OpenAI Response">
+    <p>Sanitize the response from OpenAI and returns a consistent data interface </p>
+
+    <h3>Details</h3>
+    <p>This node must be used directly after the <code>OpenAI Chat</code> node.</p>
+
+    <h4>Keep Formatting</h4>
+    By default this node will strip the response from GPT to return a clean string. 
+    This is to prevent anomolies caused by how different outputs (for example outputting to
+     telegram vs text-to-speech). However, if you would like to keep the formatting GPT returns,
+     mark the checkbox.
+
+    <h4>Clear Conversation</h4>
+    If the previous Chat node in the flow has a conversation id, then this node will clean up after 
+    it and delete the any saved conversation under the given <pre>conversation_id</pre>. This option can be 
+    dynamically triggered by setting **msg.clearConversation** to <pre>`true`</pre>
+</script>

package/openai-response/index.js

@@ -0,0 +1,154 @@
+const { end } = require("../globalUtils");
+const Sugar = require("sugar");
+const { ChatLedger } = require("../utilities/chat-ledger");
+const { TYPES } = require("../constants");
+
+module.exports = function (RED) {
+  function OpenAIResponseHandlerNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+    this.conversation_id = config.conversation_id;
+
+    /**
+     * Returns a formatted string based on the settings of the node
+     * @param {object} node - represents the current node and it's settings
+     * @param {string} content - the string response that came back from GPT
+     * @returns
+     */
+    const getResponse = (node, content = "") => {
+      if (node.keepFormatting) {
+        return content;
+      }
+      return content?.replaceAll("\n", "").trim();
+    };
+
+    const createConsistentPayload = (content) => {
+      return {
+        args: {
+          response: getResponse(config, content),
+        },
+      };
+    };
+
+    const formatPayloadForLocalAI = (msg) => {
+      const { message } = msg.payload;
+      const output = [];
+
+      if(message.tool_calls){
+        message.tool_calls.forEach((answer) => {
+
+          const payload = createConsistentPayload(answer.content);
+
+          if (answer.function) {
+            const deepCopyPayload = Sugar.Object.clone(payload, true);
+
+            deepCopyPayload.args = {
+              ...answer.function.arguments,
+            };
+            deepCopyPayload.nodeName = answer.function.name;
+            output.push(deepCopyPayload);
+
+          } else {
+            output.push(payload);
+          }
+        });
+      }
+      else{
+        output.push(createConsistentPayload(message.content));
+      }
+
+      return output
+    }; 
+    const formatPayloadForOpenAI = (msg) => {
+      const output = [];
+      // Goes through the OpenAI Response and creates a standard uniformed output
+      msg.payload.choices.forEach((answer) => {
+        const { content = "", tool_calls } = answer.message;
+        const payload = createConsistentPayload(content);
+
+        if (tool_calls) {
+          tool_calls.forEach((tool) => {
+            const deepCopyPayload = Sugar.Object.clone(payload, true);
+
+            if (tool.type === "function") {
+              deepCopyPayload.args = {
+                ...JSON.parse(tool.function.arguments),
+              };
+              deepCopyPayload.nodeName = tool.function.name;
+              output.push(deepCopyPayload);
+            }
+          });
+        } else {
+          output.push(payload);
+        }
+      });
+
+      return output;
+    };
+
+    const formatPayloadForGeminiAI = (msg) => {
+      const output = [];
+      // Goes through the OpenAI Response and creates a standard uniformed output
+      const { functions = [], message } = msg.payload;
+
+      if (functions.length > 0) {
+        functions.forEach((tool) => {
+          const { name, args } = tool;
+          const payload = createConsistentPayload(message.content);
+
+          output.push({
+            args: {
+              ...payload.args,
+              ...args,
+            },
+            nodeName: name,
+          });
+        });
+      } else {
+        output.push(createConsistentPayload(message.content));
+      }
+
+      return output;
+    };
+
+    this.on("input", function (msg, send, done = () => {}) {
+      send =
+        send ||
+        function () {
+          node.send.apply(node, arguments);
+        };
+
+      msg.originalResponse = msg.payload;
+
+      switch (msg._debug.type) {
+        case TYPES.OpenAIChat: {
+          msg.payload = formatPayloadForOpenAI(msg);
+          break;
+        }
+        case TYPES.GeminiaiChat: {
+          msg.payload = formatPayloadForGeminiAI(msg);
+          break;
+        }
+        case TYPES.LocalAIChat: {
+          msg.payload = formatPayloadForLocalAI(msg);
+          break;
+        }
+        default:
+          node.warn(
+            `Not sure where ${msg._debug.type} came from but it isn't supported`
+          );
+      }
+
+      if (config.clearConversation || msg.clearConversation) {
+        const ledger = new ChatLedger(msg._debug.conversation_id, node);
+        msg._debug.previousConversation = msg._debug.fullConversation;
+        msg._debug.fullConversation = ledger.clearConversation();
+      }
+
+      send(msg);
+      end(done);
+    });
+  }
+
+  RED.nodes.registerType(TYPES.OpenAIResponse, OpenAIResponseHandlerNode);
+};

package/openai-system/index.html

@@ -0,0 +1,68 @@
+<script type="text/javascript">
+    RED.nodes.registerType("OpenAI System", {
+        category: 'AI Intent',
+        color: 'rgba(255, 0, 119, .5)',
+        icon:"font-awesome/fa-tasks",
+        defaults: {
+            name: { value: "" },
+            instruction: { value: "" }
+        },
+        inputs: 1,
+        outputs: 1,
+        paletteLabel: "System (Deprecated)",
+        label: function () {
+            return this.name ? `${this.name} (Deprecated)` : "System (Deprecated)";
+        },
+        oneditprepare: function () {
+            this.editor = RED.editor.createEditor({
+                id: 'node-input-system-editor',
+                mode: 'ace/mode/text',
+                value: this.instruction
+            });
+        },
+        oneditsave: function () {
+            this.instruction = this.editor.getValue();
+            this.editor.destroy();
+            delete this.editor;
+        },
+        oneditcancel: function () {
+            this.editor.destroy();
+            delete this.editor;
+        },  
+    });
+</script>
+
+<script type="text/html" data-template-name="OpenAI System">
+
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-instruction"><i class="fa fa-tag"></i>System Message</label>
+        <div style="height: 250px; min-height:150px;" class="node-text-editor" id="node-input-system-editor"></div>
+    </div>
+
+   
+</script>
+
+<script type="text/html" data-help-name="OpenAI System">
+    <p>Adds a system message object to the msg object.</p>
+    
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt>System Message
+            <span class="property-type">string</span>
+        </dt>
+        <dd>Provides a way to "prime" the system and set expectations. This node will add the chat object with role "system"
+            to the payload for OpenAI </dd>
+    </dl>
+
+    <h3>Details</h3>
+    <p>This node must be used before <code>OpenAI Chat</code>. This node can also substitute strings within 
+        the given payload using <code>{}</code>. For example, given the message "Hello {foo}". 
+        if the msg object contains foo as a property that's equal to "world", then the payload sent to OpenAI 
+        would be "Hello world". If you need to send curly braces in your payload use doubld curly braces 
+        <code>{{}}</code> to escape.</p>
+</script>

package/openai-system/index.js

@@ -0,0 +1,28 @@
+const Sugar = require("sugar");
+const { TYPES, ROLES } = require("../constants");
+
+module.exports = function (RED) {
+  function OpenAISystemHandlerNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+
+    this.on("input", function (msg, send, done = () => {}) {
+      let content = msg.payload?.instruction || config.instruction;
+
+      // performs the string substitutions
+      content = Sugar.String.format(content, msg);
+
+      send =
+        send ||
+        function () {
+          node.send.apply(node, arguments);
+        };
+
+      msg.system = { role: ROLES.System, content };
+      send(msg);
+      done();
+    });
+  }
+
+  RED.nodes.registerType(TYPES.OpenAISystem, OpenAISystemHandlerNode);
+};

package/openai-tool/index.html

@@ -0,0 +1,57 @@
+<script type="text/javascript">
+    RED.nodes.registerType("OpenAI Tool", {
+        category: 'AI Intent',
+        color: 'rgba(255, 0, 119, .5)',
+        icon:"font-awesome/fa-code",
+        defaults: {
+            name: { value: "" },
+            tool: { value: "" }
+        },
+        inputs: 1,
+        outputs: 1,
+        paletteLabel: "Tool (Deprecated)",
+        label: function () {
+            return this.name ? `${this.name} (Deprecated)` : "Tool (Deprecated)";
+        },
+         oneditprepare: function () {
+
+            $("#node-input-tool").typedInput({
+                type: "json"
+            })
+        }    
+    });
+</script>
+
+<script type="text/html" data-template-name="OpenAI Tool">
+
+    <div class="form-row">
+        <label for="node-input-name"> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-tool">Tool Definition</label>
+        
+        <input id="node-input-tool" name="openai Tool"/>
+    </div>
+
+   
+</script>
+
+<script type="text/html" data-help-name="OpenAI Tool">
+    <p>Function that OpenAI can reference to respond more effectively to peculiar requests</p>
+    
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt>Tool Definition
+            <span class="property-type">json</span>
+        </dt>
+        <dd> JSON Schema that defines the function GPT can call to do work. Check out the <a href="https://platform.openai.com/docs/api-reference/chat/create">documentation</a> 
+            to see how to write the JSON schema </dd>
+    </dl>
+
+    <h3>Details</h3>
+    <p>This node should come before the <code>OpenAI Chat</code> node as this OpenAI Tool node adds the functions to 
+    the msg object for the <code>OpenAI Chat</code> to use. OpenAI is experimental so you may have to make a lot of adjustments
+to get the desired results</p>
+</script>

package/openai-tool/index.js

@@ -0,0 +1,50 @@
+const { jsonrepair } = require("jsonrepair");
+const { end, ContextDatabase } = require("../globalUtils");
+const { TYPES } = require("../constants");
+
+module.exports = function (RED) {
+  function OpenAIFunctionHandlerNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+    const nodeDB = new ContextDatabase(RED);
+    nodeDB.saveIntent(config);
+
+    this.on("input", function (msg, send, done = () => {}) {
+      let content = msg.payload?.tool || config.tool;
+      content = content?.replaceAll("\n", "").trim();
+      content = jsonrepair(content);
+
+      try {
+        content = JSON.parse(content);
+      } catch (e) {
+        end(done, e);
+      }
+
+      if (!msg.tools) {
+        msg.tools = [];
+      }
+
+      msg.tools.push(content);
+
+      send =
+        send ||
+        function () {
+          node.send.apply(node, arguments);
+        };
+
+      send(msg);
+      done();
+    });
+
+    this.on("close", function (removed, done) {
+      if (removed) {
+        nodeDB.removeIntent(config);
+      } else {
+        nodeDB.saveIntent(config);
+      }
+      end(done);
+    });
+  }
+
+  RED.nodes.registerType(TYPES.OpenAITool, OpenAIFunctionHandlerNode);
+};

package/openai-user/index.html

@@ -0,0 +1,76 @@
+<script type="text/javascript">
+    RED.nodes.registerType("OpenAI User", {
+        category: 'AI Intent',
+        color: 'rgba(255, 0, 119, .5)',
+        icon:"font-awesome/fa-user",
+        defaults: {
+            name: { value: "" },
+            content: { value: "" }
+        },
+        inputs: 1,
+        outputs: 1,
+        paletteLabel: "User (Deprecated)",
+        label: function () {
+            return this.name ? `${this.name} (Deprecated)` : "User (Deprecated)";
+        },
+        oneditprepare: function(){
+            this.editor = RED.editor.createEditor({
+                id: 'node-input-user-editor',
+                mode: 'ace/mode/text',
+                value: this.content
+            });
+        },
+        oneditsave: function () {
+            this.content = this.editor.getValue();
+            this.editor.destroy();
+            delete this.editor;
+        },
+        oneditcancel: function () {
+            this.editor.destroy();
+            delete this.editor;
+        },
+    });
+
+//     const options = intents.map(intent => {
+//         return { value: intent.id, label: intent.name }
+//     })
+
+//     options.push(DYNAMIC_OPTION)
+
+//     return options
+// }
+</script>
+
+<script type="text/html" data-template-name="OpenAI User">
+
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-content"><i class="fa fa-tag"></i>Content</label>
+        <div style="height: 250px; min-height:150px;" class="node-text-editor" id="node-input-user-editor"></div>
+    </div>
+
+   
+</script>
+
+<script type="text/html" data-help-name="OpenAI User">
+    <p>Adds an object of with a role of type "user" to the message object</p>
+    
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt>Content
+            <span class="property-type">string</span>
+        </dt>
+        <dd> Message to send to OpenAI. This can be a command, question or any string. </dd>
+    </dl>
+
+    <h3>Details</h3>
+    <p>This node must be used before <code>OpenAI Chat</code>. This node can also substitute strings within
+    the given payload using <code>{}</code>. For example, given the message "Hello {foo}".
+    if the msg object contains foo as a property that's equal to "world", then the payload sent to OpenAI
+    would be "Hello world". If you need to send curly braces in your payload use doubld curly braces
+    <code>{{}}</code> to escape.</p>
+</script>

package/openai-user/index.js

@@ -0,0 +1,26 @@
+const Sugar = require("sugar");
+const { TYPES, ROLES } = require("../constants");
+
+module.exports = function (RED) {
+  function OpenAIUserHandlerNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+
+    this.on("input", function (msg, send, done = () => {}) {
+      let content = msg.payload?.content || config.content;
+      content = Sugar.String.format(content, msg);
+
+      send =
+        send ||
+        function () {
+          node.send.apply(node, arguments);
+        };
+
+      msg.user = { role: ROLES.User, content };
+      send(msg);
+      done();
+    });
+  }
+
+  RED.nodes.registerType(TYPES.OpenAIUser, OpenAIUserHandlerNode);
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@cpwc/node-red-contrib-ai-intent",
+  "version": "3.1.0-alpha",
+  "description": "A collection of nodes to elevate a user's automation interactions",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "upload": "npm publish ./ --access public",
+    "pack": "npm pack"
+  },
+  "keywords": [
+    "node-red"
+  ],
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "node-red": {
+    "version": ">=2.0.0",
+    "nodes": {
+      "geminiai-chat": "geminiai-chat/index.js",
+      "localai-chat": "localai-chat/index.js",
+      "openai-chat": "openai-chat/index.js",
+      "openai-system": "openai-system/index.js",
+      "openai-tool": "openai-tool/index.js",
+      "openai-user": "openai-user/index.js",
+      "openai-response": "openai-response/index.js",
+      "llm-chat": "llm-chat/index.js",
+      "call-intent": "call-intent/index.js",
+      "register-intent": "register-intent/index.js",
+      "platform-configuration": "llm-chat/platform-configuration/index.js",
+      "openai-configuration": "openai-chat/openai-configuration/index.js",
+      "localai-configuration": "localai-chat/localai-configuration/index.js",
+      "geminiai-configuration": "geminiai-chat/geminiai-configuration/index.js"
+    }
+  },
+  "author": "Michael Montaque",
+  "url": "https://github.com/montaque22/node-red-contrib-ai-intent",
+  "license": "ISC",
+  "dependencies": {
+    "@google/generative-ai": "^0.11.5",
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1",
+    "jsonrepair": "^3.4.1",
+    "node-localstorage": "^3.0.5",
+    "ollama": "^0.5.1",
+    "openai": "^4.20.0",
+    "pubsub-js": "^1.9.4",
+    "sugar": "^2.0.6"
+  }
+}

package/register-intent/icons/register-icon.svg

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg width="100%" height="100%" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
+    <use xlink:href="#_Image1" x="4.695" y="3.939" width="14.76px" height="16.4px" transform="matrix(0.984018,0,0,0.964725,0,0)"/>
+    <defs>
+        <image id="_Image1" width="15px" height="17px" xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAARCAYAAAACCvahAAAACXBIWXMAAA7EAAAOxAGVKw4bAAABMUlEQVQ4jZWTsUoDQRRFzyQRjFXSSCwCBvwCLeysxCaN/oOIRf7Byn+wExS0UCFgIqQIaOsX2NkK2hkMCPFYOCtrMmTxwcLbmXfuffN2B7Wu3qlj58dEfVK3iBHUHtAGHoARILMRgAqwCSwArRDCK+qHOkgAM6Huxy7aRLUq8B43G8ARUJ7ibkIIg6wOWMpgcq3uAIcJ0wYwAL7yi5X8SwjhLB5h2vktdYw/sBqAlQQ8Aj7nwsABcJIwGQLbRfAlsJxw7icEIY7+Krk5W1tVj9XqDKxuqI/xWS8Sm267xs/AAOr/gkMIQ6BZ1DpwAYxLGTenuK62Yr4IdIFd4KXw31Y7cS4dtR/zU7WE2osL9zG/VbvqWoSb6nPuap6r5Uy5FhXz93mi7uXcV9Xr+Jl+5/QNM0UTGeaPSoQAAAAASUVORK5CYII="/>
+    </defs>
+</svg>