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

package/azure-openai-chat/azure-openai-configuration/index.html

@@ -0,0 +1,23 @@
+<script type="text/javascript">
+    RED.nodes.registerType('azure-openai-configuration', {
+        category: 'config',
+        defaults: {
+            api: { value: "", required: true },
+            endpoint: { value: "", required: true }
+        },
+        label: function () {
+            return "Azure OpenAI API Token"
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="azure-openai-configuration">
+    <div class="form-row">
+        <label for="node-config-input-api"><i class="fa fa-bookmark"></i> API Token</label>
+        <input type="text" id="node-config-input-api">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-endpoint"><i class="fa fa-bookmark"></i> Endpoint</label>
+        <input type="text" id="node-config-input-endpoint">
+    </div>
+</script>

package/azure-openai-chat/azure-openai-configuration/index.js

@@ -0,0 +1,8 @@
+module.exports = function (RED) {
+  function AzureOpenAIConfigNode(prop) {
+    RED.nodes.createNode(this, prop);
+    this.api = prop.api;
+    this.endpoint = prop.endpoint;
+  }
+  RED.nodes.registerType("azure-openai-configuration", AzureOpenAIConfigNode);
+};

package/azure-openai-chat/icons/chatgpt-icon.svg

@@ -0,0 +1,7 @@
+<?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 512 512" 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;">
+    <g>
+        <path d="M423.895,220.444C432.789,193.751 429.726,164.509 415.503,140.229C394.114,102.988 351.116,83.829 309.122,92.845C290.44,71.799 263.6,59.831 235.461,60.002C192.536,59.904 154.45,87.541 141.244,128.383C113.669,134.03 89.866,151.291 75.938,175.755C54.39,212.898 59.302,259.718 88.09,291.569C79.196,318.262 82.259,347.504 96.481,371.784C117.87,409.025 160.868,428.184 202.862,419.168C221.531,440.214 248.384,452.182 276.523,451.999C319.472,452.109 357.571,424.448 370.776,383.569C398.351,377.922 422.154,360.661 436.082,336.197C457.606,299.054 452.681,252.271 423.905,220.42L423.895,220.444ZM276.549,426.383C259.362,426.407 242.714,420.393 229.52,409.38C230.12,409.061 231.162,408.486 231.835,408.069L309.894,362.988C313.888,360.722 316.338,356.471 316.313,351.877L316.313,241.833L349.303,260.882C349.658,261.054 349.891,261.397 349.94,261.789L349.94,352.919C349.892,393.442 317.073,426.297 276.549,426.383ZM118.717,358.97C110.105,344.098 107.006,326.666 109.958,309.748C110.534,310.091 111.551,310.716 112.273,311.132L190.332,356.213C194.289,358.528 199.189,358.528 203.158,356.213L298.453,301.185L298.453,339.283C298.478,339.675 298.294,340.055 297.988,340.3L219.084,385.859C183.938,406.096 139.053,394.067 118.73,358.97L118.717,358.97ZM98.173,188.581C106.748,173.685 120.285,162.292 136.406,156.375C136.406,157.049 136.369,158.237 136.369,159.07L136.369,249.244C136.344,253.826 138.795,258.076 142.776,260.343L238.071,315.359L205.081,334.408C204.75,334.628 204.334,334.665 203.966,334.506L125.05,288.91C89.978,268.599 77.948,223.726 98.161,188.593L98.173,188.581ZM369.222,251.657L273.927,196.629L306.917,177.592C307.248,177.372 307.664,177.335 308.032,177.494L386.948,223.053C422.082,243.352 434.124,288.298 413.825,323.432C405.238,338.304 391.713,349.696 375.604,355.626L375.604,262.757C375.641,258.175 373.203,253.937 369.234,251.658L369.222,251.658L369.222,251.657ZM402.053,202.24C401.477,201.885 400.461,201.272 399.738,200.856L321.679,155.775C317.722,153.46 312.822,153.46 308.853,155.775L213.558,210.803L213.558,172.705C213.534,172.313 213.717,171.933 214.023,171.688L292.927,126.166C328.073,105.892 373.007,117.958 393.269,153.117C401.832,167.964 404.931,185.347 402.028,202.241L402.053,202.241L402.053,202.24ZM195.624,270.143L162.622,251.094C162.267,250.923 162.034,250.58 161.985,250.188L161.985,159.058C162.01,118.485 194.926,85.605 235.499,85.63C252.662,85.63 269.273,91.657 282.467,102.633C281.867,102.951 280.838,103.527 280.152,103.944L202.093,149.025C198.099,151.291 195.649,155.53 195.674,160.124L195.625,270.119L195.625,270.143L195.624,270.143ZM213.546,231.506L255.993,206.993L298.44,231.494L298.44,280.507L255.993,305.008L213.546,280.507L213.546,231.506Z" style="fill:white;fill-rule:nonzero;"/>
+    </g>
+</svg>

package/azure-openai-chat/index.html

@@ -0,0 +1,197 @@
+<script type="text/javascript">
+  (() => {
+    const DYNAMIC_OPTIONS = [
+      { value: "auto", label: "Automatic" },
+      { value: "none", label: "None" }
+    ]
+
+    const removeDuplicates = (data) => {
+      const intents = {}
+      const tools = []
+
+      data.forEach((intent => {
+        if (intent.type === "OpenAI Tool") {
+          if (!intents[intent.name]) {
+            intents[intent.name] = true
+            tools.push(intent)
+          }
+        } else {
+          tools.push(intent)
+        }
+      }))
+      return tools
+    }
+    $.getJSON('registered-intents', function (data = RED.settings.callIntentRegistry) {
+      const tools = removeDuplicates(data)
+      window.__tools = getToolOptions(tools)
+      initialize()
+    });
+
+    const getToolOptions = (intents = []) => {
+      const options = intents.map(intent => {
+        const suffix = intent.type === "Register Intent" ? " (Registered Intent)" : ""
+        return { value: intent.id, label: `${intent.name}${suffix}` }
+      })
+
+      return [...DYNAMIC_OPTIONS, ...options]
+    }
+
+    RED.nodes.registerType("Azure OpenAI Chat", {
+      category: 'AI Intent',
+      color: 'rgba(255, 0, 119, .75)',
+      icon: "chatgpt-icon.svg",
+      defaults: {
+        name: { value: "" },
+        tool_choice: {
+          value: getToolOptions(RED.settings.callIntentRegistry),
+        },
+        conversation_id: { value: "" },
+        token: { value: "", type: "azure-openai-configuration", required: false },
+        model: { value: "gpt-4o", required: true },
+        temperature: { value: .7, required: true },
+        max_tokens: { value: 1200, required: true },
+        top_p: { value: 1, required: true },
+        frequency_penalty: { value: 0, required: true },
+        presence_penalty: { value: 0, required: true },
+      },
+      inputs: 1,
+      outputs: 1,
+      paletteLabel: "Azure OpenAI (Deprecated)",
+      label: function () {
+        return this.name ? `${this.name} (Deprecated)` : "Azure OpenAI (Deprecated)";
+      },
+
+      oneditprepare: function (x) {
+        $("#node-input-temperature").typedInput({
+          type: "num",
+        })
+        $("#node-input-max_tokens").typedInput({
+          type: "num",
+        })
+        $("#node-input-top_p").typedInput({
+          type: "num",
+        })
+        $("#node-input-frequency_penalty").typedInput({
+          type: "num",
+        })
+        $("#node-input-presence_penalty").typedInput({
+          type: "num",
+        })
+
+        $.getJSON('registered-intents', function (data = RED.settings.callIntentRegistry) {
+          const tools = removeDuplicates(data)
+          window.__tools = getToolOptions(tools)
+
+          $("#node-input-tool_choice").typedInput({
+            types: [
+              {
+                value: "",
+                options: window.__tools
+              }
+            ]
+          })
+        });
+      }
+    });
+  })()
+
+</script>
+
+<script type="text/html" data-template-name="Azure OpenAI Chat">
+    <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-token"> Token</label>
+        <input type="text" id="node-input-token" placeholder="0a1b2c3b4d5e6f">
+    </div>
+    <div class="form-row">
+        <label for="node-input-conversation_id"><i class="fa fa-tag"></i> Conversation Id</label>
+        <input type="text" id="node-input-conversation_id" placeholder="any arbitrary name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-model"> Model</label>
+        <input type="text" id="node-input-model" placeholder="gpt-3.5-turbo">
+    </div>
+    <div class="form-row">
+        <label for="node-input-tool_choice"> Tool Choice</label>
+        <input type="text" id="node-input-tool_choice" placeholder="Automatic">
+    </div>
+    <div class="form-row">
+        <label for="node-input-temperature"> Temperature</label>
+        <input type="number" id="node-input-temperature" placeholder="0.7">
+    </div>
+    <div class="form-row">
+        <label for="node-input-max_tokens"> Max Tokens</label>
+        <input type="number" id="node-input-max_tokens" placeholder="1200">
+    </div>
+    <div class="form-row">
+        <label for="node-input-top_p"> Top P</label>
+        <input type="number" id="node-input-top_p" placeholder="0">
+    </div>
+    <div class="form-row">
+        <label for="node-input-frequency_penalty"> Frequency Penalty</label>
+        <input type="number" id="node-input-frequency_penalty" placeholder="0">
+    </div>
+    <div class="form-row">
+        <label for="node-input-presence_penalty"> Presence Penalty</label>
+        <input type="number" id="node-input-presence_penalty" placeholder="0">
+    </div>
+   
+</script>
+
+<script type="text/html" data-help-name="Azure OpenAI Chat">
+    <p>Calls Azure OpenAI and returns the response</p>
+    
+    <h3>Important</h3>
+    <p>To use this node you need an API key and endpoint from Azure OpenAI. Add the API key and endpoint to the settings.js file in the node-red folder under
+    the functonGlobalContext section using the key "openaiAPIKey" and "azureOpenAIEndpoint"</p>
+    <pre>
+    functionGlobalContext: {
+        openaiAPIKey: "Your API key goes here",
+        azureOpenAIEndpoint: "Your endpoint goes here"
+    }
+    </pre>
+
+    Alternatively, you can add the token via the token configuration dropdown. 
+    See the <a href="https://github.com/montaque22/node-red-contrib-ai-intent" target="_blank">Read Me</a> for more information 
+
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt class="optional">Conversation ID
+            <span class="property-type">string</span>
+        </dt>
+        <dd> By including this identifier, AI-Intent will save the conversation in the global context 
+            and will pass the entire conversation to the LLM when any Chat node with the same conversation id 
+        is triggered. This mean that you can have many Chat nodes in different flows with the same conversation id
+    and AI-Intent will ensure that conversation context is maintained between them. It should be noted that only 
+    <b>one</b> System message will be maintained. As a result the flow with the current System node will 
+overwrite any system prompt that was previously saved.</dd>
+    </dl>
+    <dl class="message-properties">
+        <dt class="required">model
+            <span class="property-type">string</span>
+        </dt>
+        <dd> Required field that dictates the model to use when calling OpenAI </dd>
+    </dl>
+    <dl class="message-properties">
+        <dt class="required">Tool Choice
+            <span class="property-type">Dropdown</span>
+        </dt>
+        <dd> This setting controls whether or not GPT uses the provided functions to respond.
+            If you want to force GPT to use a specific function, selected it from the dropdown.
+            <b>Automatic</b> lets GPT decides what is best (This is the default). <b>None</b> disables the use of functions.
+            to further optimize the API call, AI-Intent will not pass any of the tools
+            to save tokens if "None" is selected. Check documentation for more detail on 
+            how tools work: <a href="https://cookbook.openai.com/examples/how_to_call_functions_with_chat_models" target="_blank">Function Calling & Tools</a>
+        </dd>
+    </dl>
+
+    <p>To learn more about the other properties, look at <a target="_blank" href="https://platform.openai.com/docs/api-reference/chat/create">OpenAI's documentation</a></p>
+    
+    <h3>Details</h3>
+    <p>At minimum the User node should be used before this node. The OpenAI User node adds necessary
+        information to the msg object to allow the chat to work.</p>
+
+</script>

package/azure-openai-chat/index.js

@@ -0,0 +1,68 @@
+const AzureOpenAI = require("openai");
+const { OPEN_AI_KEY, TYPES, AZURE_OPENAI_ENDPOINT } = require("../constants");
+const { end } = require("../globalUtils");
+const { ChatController } = require("../utilities/chat-controller");
+const { GlobalContext } = require("../utilities/global-context");
+
+module.exports = function (RED) {
+  function AzureOpenAIChatHandlerNode(config) {
+    RED.nodes.createNode(this, config);
+    // Retrieve the config node with API token data.
+    this.token = RED.nodes.getNode(config.token);
+    const node = this;
+    this.on("input", function (msg, send, done = () => { }) {
+      const controller = new ChatController(node, config, msg, RED);
+      const nodeDB = new GlobalContext(node);
+      const apiKey =
+        node.token?.api || nodeDB.getValueFromGlobalContext(OPEN_AI_KEY);
+      const endpoint =
+        node.token?.endpoint || nodeDB.getValueFromGlobalContext(AZURE_OPENAI_ENDPOINT);
+      const apiVersion = "2025-01-01-preview";
+
+      send =
+        send ||
+        function () {
+          config.send.apply(node, arguments);
+        };
+
+      if (!apiKey) {
+        return end(
+          done,
+          "API key missing for Azure OpenAI. Please add openaiAPIKey key-value pair to the functionGlobalContext."
+        );
+      }
+      if (!endpoint) {
+        return end(
+          done,
+          "Endpoint missing for Azure OpenAI. Please add azureOpenAIEndpoint key-value pair to the functionGlobalContext."
+        );
+      }
+
+
+      const { apiProperties, toolProperties } = controller;
+      const openai = new OpenAI({ endpoint, apiKey, apiVersion });
+      const finalProps = {
+        ...toolProperties,
+        model: apiProperties.model,
+        messages: apiProperties.messages,
+        temperature: apiProperties.temperature,
+        max_tokens: apiProperties.max_tokens,
+        top_p: apiProperties.top_p,
+        frequency_penalty: apiProperties.frequency_penalty,
+        presence_penalty: apiProperties.presence_penalty,
+      };
+
+      openai.chat.completions
+        .create(finalProps)
+        .then((answer) => {
+          send(controller.mergeResponseWithMessage(answer, finalProps));
+          end(done);
+        })
+        .catch((err) => {
+          end(done, err);
+        });
+    });
+  }
+
+  RED.nodes.registerType(TYPES.AzureOpenAIChat, AzureOpenAIChatHandlerNode);
+};

package/constants.js

@@ -5,9 +5,11 @@ module.exports = {
   INTENT_STORE: "intent_store",
   ACTIVE_CONVERSATION: "active_conversation_context",
   CONVERSATION_CONTEXT: "conversation_context",
+  AZURE_OPENAI_ENDPOINT: "azure_openai_endpoint",
   TYPES: {
     RegisterIntent: "Register Intent",
     CallIntent: "Call Intent",
+    AzureOpenAIChat: "Azure OpenAI Chat",
     OpenAIChat: "OpenAI Chat",
     LLMChat: "LLM Chat",
     LocalAIChat: "LocalAI Chat",

package/openai-response/index.html

@@ -2,11 +2,11 @@
     RED.nodes.registerType("OpenAI Response", {
         category: 'AI Intent',
         color: 'rgba(255, 0, 119, .5)',
-        icon:"font-awesome/fa-commenting-o",
+        icon: "font-awesome/fa-commenting-o",
         defaults: {
             name: { value: "" },
-            keepFormatting: {value: false},
-            clearConversation: {value: false}
+            keepFormatting: { value: false },
+            clearConversation: { value: false }
         },
         inputs: 1,
         outputs: 1,
@@ -15,8 +15,8 @@
             return this.name ? `${this.name} (Deprecated)` : "Response (Deprecated)";
         },
 
-        oneditprepare: function(x){
-           
+        oneditprepare: function (x) {
+
         }
     });
 
@@ -63,4 +63,4 @@
     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>
+</script>

package/openai-response/index.js

@@ -34,7 +34,7 @@ module.exports = function (RED) {
       const { message } = msg.payload;
       const output = [];
 
-      if(message.tool_calls){
+      if (message.tool_calls) {
         message.tool_calls.forEach((answer) => {
 
           const payload = createConsistentPayload(answer.content);
@@ -53,12 +53,12 @@ module.exports = function (RED) {
           }
         });
       }
-      else{
+      else {
         output.push(createConsistentPayload(message.content));
       }
 
       return output
-    }; 
+    };
     const formatPayloadForOpenAI = (msg) => {
       const output = [];
       // Goes through the OpenAI Response and creates a standard uniformed output
@@ -111,7 +111,7 @@ module.exports = function (RED) {
       return output;
     };
 
-    this.on("input", function (msg, send, done = () => {}) {
+    this.on("input", function (msg, send, done = () => { }) {
       send =
         send ||
         function () {
@@ -121,6 +121,10 @@ module.exports = function (RED) {
       msg.originalResponse = msg.payload;
 
       switch (msg._debug.type) {
+        case TYPES.AzureOpenAIChat: {
+          msg.payload = formatPayloadForOpenAI(msg);
+          break;
+        }
         case TYPES.OpenAIChat: {
           msg.payload = formatPayloadForOpenAI(msg);
           break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cpwc/node-red-contrib-ai-intent",
-  "version": "3.1.0-alpha",
+  "version": "3.1.2-alpha",
   "description": "A collection of nodes to elevate a user's automation interactions",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
@@ -19,6 +19,7 @@
       "geminiai-chat": "geminiai-chat/index.js",
       "localai-chat": "localai-chat/index.js",
       "openai-chat": "openai-chat/index.js",
+      "azure-openai-chat": "azure-openai-chat/index.js",
       "openai-system": "openai-system/index.js",
       "openai-tool": "openai-tool/index.js",
       "openai-user": "openai-user/index.js",
@@ -28,6 +29,7 @@
       "register-intent": "register-intent/index.js",
       "platform-configuration": "llm-chat/platform-configuration/index.js",
       "openai-configuration": "openai-chat/openai-configuration/index.js",
+      "azure-openai-configuration": "azure-openai-chat/azure-openai-configuration/index.js",
       "localai-configuration": "localai-chat/localai-configuration/index.js",
       "geminiai-configuration": "geminiai-chat/geminiai-configuration/index.js"
     }

package/utilities/chat-ledger.js

@@ -18,7 +18,7 @@ class ChatLedger {
       conversation.push(message);
     });
 
-    if (type === TYPES.OpenAIChat) {
+    if (type === TYPES.OpenAIChat || type === TYPES.AzureOpenAIChat) {
       response.choices.forEach(({ message }) => {
         const { role, content = "", tool_calls } = message;