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

package/llm-chat/ChatGPTHelper.js

@@ -0,0 +1,197 @@
+const { GlobalContext } = require("../utilities/global-context");
+const { TOOL_CHOICE} = require("../constants");
+const OpenAI = require("openai");
+const {ContextDatabase} = require("../globalUtils");
+const {ConversationHistory} = require("../utilities/conversationHistory");
+const {Format} = require("../utilities/format");
+
+const chatGPTHelper = (props,callback) => {
+    const {node, config, msg, RED} = props
+    const nodeDB = new GlobalContext(node);
+    const {model, credentials} = node.platform
+    const apiKey = credentials.api
+
+    if (!apiKey) {
+        node.status({fill:"red",shape:"dot",text:"Error"});
+        return callback("Api key missing for OpenAI. Please add openaiAPIKey key-value pair to the functionGlobalContext.");
+    }
+
+    const openai = new OpenAI({ apiKey });
+    const {options = {}, system = "", user = ""} = msg?.payload || {}
+    const conversation_id = config.conversation_id;
+    const conversationHistory = new ConversationHistory(nodeDB, conversation_id)
+
+    if(msg.clearChatHistory){
+        conversationHistory.clearHistory()
+        node.warn("Conversation history cleared")
+    }
+
+    if(!user){
+        node.status({fill:"red",shape:"dot",text:"Stopped"});
+       return node.warn("payload.user is empty. Stopping the flow ")
+    }
+
+    conversationHistory.addSystemMessage(system)
+    conversationHistory.addUserMessage(user)
+
+    if(conversation_id) {
+        conversationHistory.saveHistory()
+    }
+
+    const toolProperties = getToolProperties(config, msg.tools, RED)
+    const finalProps = {
+        ...options,
+        ...toolProperties,
+        model,
+        messages: conversationHistory.conversation
+    };
+
+    openai.chat.completions
+        .create(finalProps)
+        .then((response) => {
+
+            response.choices.forEach(choice => {
+                conversationHistory.addAssistantMessage(choice.message.content)
+            })
+            conversationHistory.saveHistory()
+
+            return createPayload(finalProps, response, msg, conversationHistory.conversation)
+        })
+        .then(msg => {
+            callback(null, msg)
+        })
+        .catch((err) => {
+            callback(err)
+        });
+}
+
+const createPayload = (request, response, previousMsg, conversationHistory) => {
+    const format = new Format()
+    const payload = format.formatPayloadForOpenAI(response.choices)
+
+    return {
+        ...previousMsg,
+        payload,
+        apiResponse: response,
+       _debug: {
+         ...request,
+           messages: conversationHistory
+       },
+   }
+}
+
+const getAllTools = (RED) => {
+    const context = new ContextDatabase(RED);
+    const intents = context.getNodeStore() || {};
+    return createFunctionsFromContext(intents)
+}
+
+/**
+ * Converts the raw intents into functions that the LLM can use.
+ * @param {*} node
+ * @returns
+ */
+getRegisteredIntentFunctions = (RED) => {
+    const intents = getRawIntents(RED);
+    return createFunctionsFromContext(intents);
+};
+
+/**
+ * This will return all stored Registered Intents throughout the entire system
+ * and Tool Nodes that are attached directly to this flow
+ * This will return:
+ *  type RawIntent = {
+ *    [node_id]: node // could be Registered Intent or Tool node
+ *  }
+ */
+getRawIntents = (RED) => {
+    const context = new ContextDatabase(RED);
+    return context.getNodeStore() || {};
+};
+
+/**
+ * converts the registered intents stored in the context into functions that can be used by the LLM.
+ * The registered intent will be ignored if excludeFromOpenAi is set to true.
+ * rawIntents may have tool nodes included so the values need to be filtered by the node type.
+ * rawIntents have the following shape:
+ *
+ * type RawIntents = {
+ *  [node_id]: node // node could be Registered Intent or Tool node
+ * }
+ */
+const createFunctionsFromContext = (rawIntents = {}) => {
+    return (
+        Object.values(rawIntents)
+            .filter((payload) => {
+                return payload.type === "Register Intent";
+            })
+            .map((payload) => {
+                if (payload.excludeFromOpenAi) {
+                    return undefined;
+                }
+
+                const parameters = payload.code?.trim() ?
+                    JSON.parse(payload.code) : {type: "object", properties: {}, required: []};
+
+
+                //TODO -  Remove after all the old versions are deprecated
+                const {properties = {}, required = []} = parameters
+                required.push("isRegisteredIntent")
+                properties.isRegisteredIntent = { type:"boolean", const: true }
+
+                return {
+                    type: "function",
+                    function: {
+                        name: payload.name,
+                        description: payload.description,
+                        parameters: {
+                            ...parameters,
+                            properties,
+                            required,
+                            additionalProperties: false
+                        },
+                        strict: true
+                    },
+                };
+            })
+            .filter(Boolean) || []
+    );
+};
+
+
+/**
+ *
+ * @param config
+ * @param deprecatedTools
+ * @returns {{}}
+ */
+const getToolProperties = (
+    config,
+    deprecatedTools = [],
+    RED
+) => {
+
+    const tool_choice = config.tool_choice
+    const tool_string_ids = config.tools;
+    const tool_ids = tool_string_ids.split(",");
+    const toolProperties = {}
+    const allTools = getAllTools(RED)
+    const tools = []
+
+    if(tool_choice !== TOOL_CHOICE.None){
+        [...deprecatedTools, ...allTools].forEach(tool => {
+            if(tool_ids.includes(tool.function.name)){
+                tools.push(tool);
+            }
+        })
+
+        toolProperties.tools = tools
+        toolProperties.tool_choice = tool_choice
+    }
+
+    return toolProperties
+}
+
+module.exports = {
+    chatGPTHelper
+}

package/llm-chat/GeminiHelper.js

@@ -0,0 +1,260 @@
+const { GlobalContext } = require("../utilities/global-context");
+const { TOOL_CHOICE} = require("../constants");
+const {ContextDatabase, end} = require("../globalUtils");
+const {ConversationHistory} = require("../utilities/conversationHistory");
+const {Format} = require("../utilities/format");
+const { GoogleGenerativeAI } = require("@google/generative-ai");
+const Sugar = require("sugar");
+
+const geminiHelper = (props,callback) => {
+    const {node, config, msg, RED} = props
+    const nodeDB = new GlobalContext(node);
+    const {model, credentials} = node.platform
+    const apiKey = credentials.api
+
+    if (!apiKey) {
+        node.status({fill:"red",shape:"dot",text:"Error"});
+        return callback("Api key missing for Gemini. Please update the configuration");
+    }
+
+    const {options , system = "", user = ""} = msg?.payload || {}
+    const conversation_id = config.conversation_id;
+    const conversationHistory = new ConversationHistory(nodeDB, conversation_id)
+
+    if(msg.clearChatHistory){
+        conversationHistory.clearHistory()
+        node.warn("Conversation history cleared")
+    }
+
+    if(!user){
+        node.status({fill:"red",shape:"dot",text:"Stopped"});
+       return node.warn("payload.user is empty. Stopping the flow ")
+    }
+
+    conversationHistory.addSystemMessage(system)
+    conversationHistory.addUserMessage(user)
+
+    if(conversation_id) {
+        conversationHistory.saveHistory()
+    }
+
+    // Access your API key as an environment variable (see "Set up your API key" above)
+    const genAI = new GoogleGenerativeAI(apiKey);
+    const toolProperties = getToolProperties(config, msg.tools, RED)
+    const modelParams = {
+        ...toolProperties,
+        model
+    };
+
+    if(options && typeof options === "object"){
+        modelParams.generationConfig = options
+    }
+
+    // The Gemini 1.5 models are versatile and work with most use cases
+    const genModel = genAI.getGenerativeModel(modelParams);
+    const {history,message, updated} = convertChatToGeminiCompatibleChat(conversationHistory.conversation)
+    const chat = genModel.startChat({
+        history,
+    });
+    const finalProps = {
+        ...modelParams,
+        messages: updated
+    };
+    chat
+        .sendMessage(message)
+        .then((result) => result.response)
+        .then((response) => {
+            return {
+                functions: response.functionCalls() || [],
+                text: response.text(),
+            };
+        })
+        .then((payload) => {
+            console.log("RESPONSE: ", payload)
+            conversationHistory.addAssistantMessage(payload.text)
+            conversationHistory.saveHistory()
+
+            return createPayload(finalProps, payload, msg)
+        })
+        .then(msg => {
+            callback(null, msg)
+        })
+        .catch((err) => {
+            callback(err)
+        });
+}
+
+const createPayload = (request, response, previousMsg) => {
+    const format = new Format()
+    const payload = format.formatPayloadForGeminiAI(response)
+
+    return {
+        ...previousMsg,
+        payload,
+        apiResponse: response,
+       _debug: {
+         ...request
+       },
+   }
+}
+
+const getAllTools = (RED) => {
+    const context = new ContextDatabase(RED);
+    const intents = context.getNodeStore() || {};
+    return createFunctionsFromContext(intents)
+}
+
+/**
+ * Converts the raw intents into functions that the LLM can use.
+ * @param {*} node
+ * @returns
+ */
+getRegisteredIntentFunctions = (RED) => {
+    const intents = getRawIntents(RED);
+    return createFunctionsFromContext(intents);
+};
+
+/**
+ * This will return all stored Registered Intents throughout the entire system
+ * and Tool Nodes that are attached directly to this flow
+ * This will return:
+ *  type RawIntent = {
+ *    [node_id]: node // could be Registered Intent or Tool node
+ *  }
+ */
+getRawIntents = (RED) => {
+    const context = new ContextDatabase(RED);
+    return context.getNodeStore() || {};
+};
+
+/**
+ * converts the registered intents stored in the context into functions that can be used by the LLM.
+ * The registered intent will be ignored if excludeFromOpenAi is set to true.
+ * rawIntents may have tool nodes included so the values need to be filtered by the node type.
+ * rawIntents have the following shape:
+ *
+ * type RawIntents = {
+ *  [node_id]: node // node could be Registered Intent or Tool node
+ * }
+ */
+const createFunctionsFromContext = (rawIntents = {}) => {
+    return (
+        Object.values(rawIntents)
+            .filter((payload) => {
+                return payload.type === "Register Intent";
+            })
+            .map((payload) => {
+                if (payload.excludeFromOpenAi) {
+                    return undefined;
+                }
+                const parameters = payload.code.trim() ?
+                    JSON.parse(payload.code) : {type: "object", properties: {}, required: []};
+
+
+                //TODO -  Remove after all the old versions are deprecated
+                const {properties = {}, required = []} = parameters
+                required.push("isRegisteredIntent")
+                properties.isRegisteredIntent = {  type: "string", enum: ["true"]  }
+
+                return {
+                    type: "function",
+                    function: {
+                        name: payload.name,
+                        description: payload.description,
+                        parameters: {
+                            ...parameters,
+                            properties,
+                            required,
+                        }
+                    }
+                };
+            })
+            .filter(Boolean) || []
+    );
+};
+
+
+const convertChatToGeminiCompatibleChat = (messages = []) => {
+    const original = Sugar.Object.clone(messages, true);
+    const updated = messages.map((message) => {
+        let role = message.role;
+        // Gemini doesn't seem to have a system role. We wil convert it to a user
+        if (role === "system") {
+            role = "user";
+        }
+
+        return { role, parts: [{ text: message.content }] };
+    });
+
+    const history = Sugar.Object.clone(updated, true);
+    const nextMessage = history.pop()
+    const message = nextMessage?.parts[0]?.text || "";
+
+    return {
+        original, // contains  the full chat in it's original form
+        updated, // full list of gemini compatible chat
+        message, // the next gemini compatible chat item
+        history // contains the gemini compatible chat w/o the user's current message (the last message in the array)
+    };
+};
+
+const convertToolsToGeminiCompatibleTools = (tools = []) => {
+    return {
+        functionDeclarations: tools.map((tool) => {
+            return tool.function;
+        }),
+    };
+};
+
+
+/**
+ *
+ * @param config
+ * @param deprecatedTools
+ * @returns {{}}
+ */
+const getToolProperties = (
+    config,
+    deprecatedTools = [],
+    RED
+) => {
+    const mode = convertToolChoiceToGeminiCompatibleChoice(config.tool_choice)
+    const tool_string_ids = config.tools;
+    const allowed_function_names = tool_string_ids.split(",");
+    const toolProperties = {}
+    const allTools = getAllTools(RED)
+    const tools = []
+    const tool_config = {
+        function_calling_config:{
+            mode,
+            allowed_function_names
+        }
+    }
+
+    if(mode !== TOOL_CHOICE.None){
+        [...deprecatedTools, ...allTools].forEach(tool => {
+            if(allowed_function_names.includes(tool.function.name)){
+                tools.push(tool);
+            }
+        })
+
+        toolProperties.tools = convertToolsToGeminiCompatibleTools(tools)
+        toolProperties.tool_config = tool_config
+    }
+
+    return toolProperties
+}
+
+function convertToolChoiceToGeminiCompatibleChoice(mode){
+    switch(mode){
+        case TOOL_CHOICE.Required:
+            return TOOL_CHOICE.Any.toUpperCase()
+        default:
+            return mode.toUpperCase()
+    }
+}
+
+
+module.exports = {
+    geminiHelper
+}

package/llm-chat/OllamaHelper.js

@@ -0,0 +1,196 @@
+const { GlobalContext } = require("../utilities/global-context");
+const { TOOL_CHOICE} = require("../constants");
+const {ContextDatabase} = require("../globalUtils");
+const {ConversationHistory} = require("../utilities/conversationHistory");
+const {Format} = require("../utilities/format");
+const {Ollama} = require("ollama");
+
+const ollamaHelper = (props,callback) => {
+    const {node, config, msg, RED} = props
+    const nodeDB = new GlobalContext(node);
+    const {url: host, model} = node.platform
+
+    if (!host) {
+        node.status({fill:"red",shape:"dot",text:"Error"});
+        return callback("URL is missing. Please update the config to point to a valid URL for your local llm");
+    }
+
+    const {options = {}, system = "", user = ""} = msg?.payload || {}
+    const conversation_id = config.conversation_id;
+    const conversationHistory = new ConversationHistory(nodeDB, conversation_id)
+
+    if(msg.clearChatHistory){
+        conversationHistory.clearHistory()
+        node.warn("Conversation history cleared")
+    }
+
+    if(!user){
+        node.status({fill:"red",shape:"dot",text:"Stopped"});
+       return node.warn("payload.user is empty. Stopping the flow ")
+    }
+
+    conversationHistory.addSystemMessage(system)
+    conversationHistory.addUserMessage(user)
+
+    if(conversation_id) {
+        conversationHistory.saveHistory()
+    }
+
+    const toolProperties = getToolProperties(config, msg.tools, RED)
+    const finalProps = {
+        ...options,
+        ...toolProperties,
+        model,
+        messages: conversationHistory.conversation
+    };
+
+    const ollama = new Ollama({ host });
+
+    ollama.chat(finalProps)
+        .then((response) => {
+            console.log("RESPONSE: ", response)
+
+            conversationHistory.addAssistantMessage(response.message.content)
+            conversationHistory.saveHistory()
+
+            return createPayload(finalProps, response, msg, conversationHistory.conversation)
+        })
+        .then(msg => {
+            callback(null, msg)
+        })
+        .catch((err) => {
+            callback(err)
+        });
+}
+
+const createPayload = (request, response, previousMsg, conversationHistory) => {
+    const format = new Format()
+
+    const payload = format.formatPayloadForLocalAI(response.message)
+
+    return {
+        ...previousMsg,
+        payload,
+        apiResponse: response,
+       _debug: {
+         ...request,
+           messages: conversationHistory
+       },
+   }
+}
+
+const getAllTools = (RED) => {
+    const context = new ContextDatabase(RED);
+    const intents = context.getNodeStore() || {};
+    return createFunctionsFromContext(intents)
+}
+
+/**
+ * Converts the raw intents into functions that the LLM can use.
+ * @param {*} node
+ * @returns
+ */
+getRegisteredIntentFunctions = (RED) => {
+    const intents = getRawIntents(RED);
+    return createFunctionsFromContext(intents);
+};
+
+/**
+ * This will return all stored Registered Intents throughout the entire system
+ * and Tool Nodes that are attached directly to this flow
+ * This will return:
+ *  type RawIntent = {
+ *    [node_id]: node // could be Registered Intent or Tool node
+ *  }
+ */
+getRawIntents = (RED) => {
+    const context = new ContextDatabase(RED);
+    return context.getNodeStore() || {};
+};
+
+/**
+ * converts the registered intents stored in the context into functions that can be used by the LLM.
+ * The registered intent will be ignored if excludeFromOpenAi is set to true.
+ * rawIntents may have tool nodes included so the values need to be filtered by the node type.
+ * rawIntents have the following shape:
+ *
+ * type RawIntents = {
+ *  [node_id]: node // node could be Registered Intent or Tool node
+ * }
+ */
+const createFunctionsFromContext = (rawIntents = {}) => {
+    return (
+        Object.values(rawIntents)
+            .filter((payload) => {
+                return payload.type === "Register Intent";
+            })
+            .map((payload) => {
+                if (payload.excludeFromOpenAi) {
+                    return undefined;
+                }
+                const parameters = payload.code.trim() ?
+                    JSON.parse(payload.code) : {type: "object", properties: {}, required: []};
+
+
+                //TODO -  Remove after all the old versions are deprecated
+                const {properties = {}, required = []} = parameters
+                required.push("isRegisteredIntent")
+                properties.isRegisteredIntent = { type:"boolean", const: true }
+
+                return {
+                    type: "function",
+                    function: {
+                        name: payload.name,
+                        description: payload.description,
+                        parameters: {
+                            ...parameters,
+                            properties,
+                            required,
+                            additionalProperties: false
+                        },
+                        strict: true
+                    },
+                };
+            })
+            .filter(Boolean) || []
+    );
+};
+
+
+/**
+ *
+ * @param config
+ * @param deprecatedTools
+ * @returns {{}}
+ */
+const getToolProperties = (
+    config,
+    deprecatedTools = [],
+    RED
+) => {
+
+    const tool_choice = config.tool_choice
+    const tool_string_ids = config.tools;
+    const tool_ids = tool_string_ids.split(",");
+    const toolProperties = {}
+    const allTools = getAllTools(RED)
+    const tools = []
+
+    if(tool_choice !== TOOL_CHOICE.None){
+        [...deprecatedTools, ...allTools].forEach(tool => {
+            if(tool_ids.includes(tool.function.name)){
+                tools.push(tool);
+            }
+        })
+
+        toolProperties.tools = tools
+        toolProperties.tool_choice = tool_choice
+    }
+
+    return toolProperties
+}
+
+
+module.exports = {
+    ollamaHelper
+}

package/llm-chat/icons/bot-message-square.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#ffffff" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-bot-message-square"><path d="M12 6V2H8"/><path d="m8 18-4 4V8a2 2 0 0 1 2-2h12a2 2 0 0 1 2 2v8a2 2 0 0 1-2 2Z"/><path d="M2 12h2"/><path d="M9 11v2"/><path d="M15 11v2"/><path d="M20 12h2"/></svg>

package/llm-chat/icons/brain-circuit.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#ffffff" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-brain-circuit"><path d="M12 5a3 3 0 1 0-5.997.125 4 4 0 0 0-2.526 5.77 4 4 0 0 0 .556 6.588A4 4 0 1 0 12 18Z"/><path d="M9 13a4.5 4.5 0 0 0 3-4"/><path d="M6.003 5.125A3 3 0 0 0 6.401 6.5"/><path d="M3.477 10.896a4 4 0 0 1 .585-.396"/><path d="M6 18a4 4 0 0 1-1.967-.516"/><path d="M12 13h4"/><path d="M12 18h6a2 2 0 0 1 2 2v1"/><path d="M12 8h8"/><path d="M16 8V5a2 2 0 0 1 2-2"/><circle cx="16" cy="13" r=".5"/><circle cx="18" cy="3" r=".5"/><circle cx="20" cy="21" r=".5"/><circle cx="20" cy="8" r=".5"/></svg>

package/llm-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>