@technithusiast/node-red-contrib-ai-intent 1.1.52
A collection of nodes to elevate a user's automation interactions
AI Intent
This is a collection of nodes to help enhance existing automations to be utilized by chatbots and take advantage of LLM's like GPT. There are 4 Nodes in this collection:
Note: This uses GPT's Chat Completion API which is now considered Legacy. If it becomes deprecated. I will do my best to update this to leverage something equivalent.
Register Intent
This node creates a subscription that can be activated by the Call Intent node. At minimum this node can be used as a way to link automations in different flows very similar to the native Link In/Link Out nodes but it is unrestricted in where it can be used. Additionally, these nodes are automatically added to the OpenAI Chat node's payload as functions OpenAI can call. If this negatively affects your results, you can exclude them from the payload using the excludeFromOpenAI checkbox.
You cannot have to Register Intent nodes with the same name. This will lead to unintended results
Call Intent
Triggers the associated Register Intent node. When this node is attached directly after the OpenAI Response node, it can dynamically trigger Registered intents. To see this in action check the examples folder and look for the openai-call-registered-intent-example.json.
To learn more about both the Call and Register Intent, watch the video below.
OpenAI Chat
Calls OpenAI by constructing a payload using the information from OpenAI User, OpenAI System, and OpenAI Tools. The three aforementioned nodes must be used first during the flow as they provide necessary information for OpenAI Chat to use.
OpenAI User
Provides the message with role = user to use in OpenAI's chat completition Payload. This node is also capable of utilizing string substitution and can replace tokenized content in the string payload with data from the msg object. Any text wrapped in single curly brace {} will be treated as a key in the msg object.
OpenAI System
Provides the message with role = system to use in OpenAI's chat completition Payload. This node is also capable of utilizing string substitution and can replace tokenized content in the string payload with data from the msg object. Any text wrapped in single curly brace {} will be treated as a key in the msg object.
OpenAI Tool
Provide functions the Open AI can use to handle unique requests. These nodes can be chain with other OpenAI Tool nodes and the system will automatically append subsequent functions to the same payload.
OpenAI Response
Sanitizes the response from OpenAI. This provides a consistent easy to read output but it will also pass the original OpenAI output in a separate property called originalResponse.
How to use
NOTE: You need to have a valid token from OpenAI for this to work. Visit OpenAI.
Once you have a valid token there are two ways to install it.
Configuration Node
When you use the OpenAI Chat node there is a Token dropdown. Click the pencil icon and paste the token key into the text box and click add. This method is the easiest however it you should be careful when exporting your flows as the token will be added to the exported JSON.
Settings.js File
Alternatively, you can add your token to the settings.js file. The file can be found under .node-red/settings.js path (or some equivalent). Based on reports from various users the location seems to be slightly different based on how you installed it. You may want to do a global search for it if you're having trouble. Once you find the file search for the functionGlobalContext property and add the following:
functionGlobalContext: {
openaiAPIKey: "YOUR-TOKEN-API-GOES-HERE",
},
Make sure you restart node-red once you save this file. This method is more complicated than the Configuration node however you can freely share and export your flows and automations as the token will be hidden from the flow.
Home Assistant Users: if you installed node-red as an addon, your settings.js file may be in a different location. Try looking for a folder called addon_configs and look for a folder ending with _nodered. You may need the Samba Addon in order to see all the folders.
Watch this video to learn how to use this plugin
Alternatively, you can check out Chaperone to get a quick overview of each node with example automations
