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

package/examples/home-assistant-automation.json

@@ -0,0 +1,167 @@
+[
+    {
+        "id": "17bc360ebf2f52da",
+        "type": "api-render-template",
+        "z": "b9203c19c137b9ca",
+        "name": "",
+        "server": "228d3d53.df8e02",
+        "version": 0,
+        "template": "Available Devices:\n```json\n{\n  \"current time\": {{now()}},\n{% set lights =  expand(states.light) %}\n{%- for area in areas() %}\n  {%- set area_info = namespace(printed=false) %}\n  {%- for device in area_devices(area) -%}\n    {%- if not device_attr(device, \"disabled_by\") and not device_attr(device, \"entry_type\") and device_attr(device, \"name\") %}\n      {%- if not area_info.printed %}\n\n        \"{{ area_name(area) }}\": {\n          {%- set area_info.printed = true -%}\n          \"lights\": [\n            {%- for light in lights -%}\n              {%- if area_name(light.entity_id) == area_name(area) %}\n                {\n                  \"entity name\": \"{{light.name}}\",\n                  \"id\": \"{{light.entity_id}}\",\n                  \"state\": \"{{light.state}}\",\n                  \"timestamp\": \"{{ as_timestamp(light.last_changed) | timestamp_custom('%m-%d-%y %I:%M %p') }}\"\n                },\n              {%- endif %}\n            {%- endfor %}\n          ],\n         \n          \"doors and windows\": [\n            {%- for sensor in expand(states.binary_sensor.ring_contact_sensors) -%}\n              {%- if area_name(sensor.entity_id) == area_name(area) %}\n                {\n                  \"entity name\": \"{{sensor.name}}\",\n                  \"id\": \"{{sensor.entity_id}}\",\n                  \"state\": \"{% if states(sensor.entity_id) == 'on'%}open {%else%}closed {%endif%}\",\n                  \"timestamp\": \"{{ as_timestamp(sensor.last_changed) | timestamp_custom('%m-%d-%y %I:%M %p') }}\"\n                },\n              {%- endif %}\n            {%- endfor %}\n          ]\n        }\n        \n      {%- endif -%}\n    {%- endif %}\n  {%- endfor %}\n{%- endfor %}\n}\n```",
+        "resultsLocation": "summary",
+        "resultsLocationType": "msg",
+        "templateLocation": "template",
+        "templateLocationType": "msg",
+        "x": 360,
+        "y": 700,
+        "wires": [
+            [
+                "1b2cb2b75a5a2fe2"
+            ]
+        ]
+    },
+    {
+        "id": "1b2cb2b75a5a2fe2",
+        "type": "OpenAI User",
+        "z": "b9203c19c137b9ca",
+        "name": "",
+        "content": "{prompt}",
+        "x": 350,
+        "y": 740,
+        "wires": [
+            [
+                "82fe0e2b3fbd6cd2"
+            ]
+        ]
+    },
+    {
+        "id": "82fe0e2b3fbd6cd2",
+        "type": "OpenAI System",
+        "z": "b9203c19c137b9ca",
+        "name": "",
+        "instruction": "You possess the knowledge of all the universe, answer any question given to you truthfully and to your fullest ability.  \nYou are also a smart home manager, named Ke, who has been given permission to control my smart home which is powered by Home Assistant.\nI will provide you information about my smart home along, you can truthfully make corrections or respond in polite and concise language.\n\n{summary}\nUser is located in the {location}\n\nThe current state of devices is provided in Available Devices.\nOnly use the execute_services function when smart home actions are requested.\nDo not tell me what you're thinking about doing either, just do it.\nIf I ask you about the current state of the home, or many devices I have, or how many devices are in a specific state, just respond with the accurate information but do not call the execute_services function.\nIf I ask you what time or date it is be sure to respond in a human readable format.\nIf you don't have enough information to execute a smart home command then specify what other information you need.",
+        "x": 340,
+        "y": 780,
+        "wires": [
+            [
+                "fb67875ebc73a3ff"
+            ]
+        ]
+    },
+    {
+        "id": "f2aa9233e44a12b4",
+        "type": "OpenAI Chat",
+        "z": "b9203c19c137b9ca",
+        "name": "",
+        "model": "gpt-4-1106-preview",
+        "temperature": 0.7,
+        "max_tokens": 1200,
+        "top_p": 1,
+        "frequency_penalty": 0,
+        "presence_penalty": 0,
+        "x": 350,
+        "y": 860,
+        "wires": [
+            [
+                "ab9b59dc4a6aadf8"
+            ]
+        ]
+    },
+    {
+        "id": "ab9b59dc4a6aadf8",
+        "type": "OpenAI Response",
+        "z": "b9203c19c137b9ca",
+        "name": "",
+        "x": 330,
+        "y": 900,
+        "wires": [
+            [
+                "2c78c52f1c872c2f"
+            ]
+        ]
+    },
+    {
+        "id": "2c78c52f1c872c2f",
+        "type": "debug",
+        "z": "b9203c19c137b9ca",
+        "name": "debug 142",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "true",
+        "targetType": "full",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 570,
+        "y": 900,
+        "wires": []
+    },
+    {
+        "id": "fae6fc0d7ac5c16b",
+        "type": "inject",
+        "z": "b9203c19c137b9ca",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "prompt",
+                "v": "How many lights are on?",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "",
+        "payloadType": "date",
+        "x": 160,
+        "y": 700,
+        "wires": [
+            [
+                "17bc360ebf2f52da"
+            ]
+        ]
+    },
+    {
+        "id": "fb67875ebc73a3ff",
+        "type": "OpenAI Tool",
+        "z": "b9203c19c137b9ca",
+        "name": "execute_services",
+        "tool": "{\"type\":\"function\",\"function\":{\"name\":\"execute_services\",\"description\":\"Use this function to execute service of devices in Home Assistant.\",\"parameters\":{\"type\":\"object\",\"properties\":{\"list\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"domain\":{\"type\":\"string\",\"description\":\"The service to be called\"},\"service\":{\"type\":\"string\",\"description\":\"The service to be called\"},\"target\":{\"type\":\"object\",\"description\":\"The service data object to indicate what to control.\",\"properties\":{\"entity_id\":{\"type\":\"string\",\"description\":\"The entity_id retrieved from available devices. It must start with domain, followed by dot character.\"}},\"required\":[\"entity_id\"]}},\"required\":[\"domain\",\"service\",\"target\"]}},\"response\":{\"type\":\"string\",\"description\":\"A friendly response to the given command\"}}}}}",
+        "x": 330,
+        "y": 820,
+        "wires": [
+            [
+                "f2aa9233e44a12b4"
+            ]
+        ]
+    },
+    {
+        "id": "865aa4b5f2775a4b",
+        "type": "comment",
+        "z": "b9203c19c137b9ca",
+        "name": "Example: Answers questions about the lights in your smart home",
+        "info": "This execute_services was adapted from [jekalmin](https://github.com/jekalmin/extended_openai_conversation)\nThe System context was adapted from [FutureProofHomes](https://www.youtube.com/watch?v=pAKqKTkx5X4&t=2s)",
+        "x": 330,
+        "y": 660,
+        "wires": []
+    },
+    {
+        "id": "228d3d53.df8e02",
+        "type": "server",
+        "name": "Home Assistant",
+        "addon": false,
+        "rejectUnauthorizedCerts": true,
+        "ha_boolean": "",
+        "connectionDelay": false,
+        "cacheJson": false,
+        "heartbeat": false,
+        "heartbeatInterval": "",
+        "statusSeparator": "",
+        "enableGlobalContextStore": false
+    }
+]

package/examples/llm-chat-node-example.json

@@ -0,0 +1,208 @@
+[
+    {
+        "id": "26ee7fb33da44441",
+        "type": "debug",
+        "z": "63287583ae175fca",
+        "name": "debug 210",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "true",
+        "targetType": "full",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 770,
+        "y": 1960,
+        "wires": []
+    },
+    {
+        "id": "8bdac3a059f6e50a",
+        "type": "inject",
+        "z": "63287583ae175fca",
+        "name": "1. What is your name",
+        "props": [],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 220,
+        "y": 1880,
+        "wires": [
+            [
+                "2f3c668301d9dd35"
+            ]
+        ]
+    },
+    {
+        "id": "c2a53eff4506daf9",
+        "type": "LLM Chat",
+        "z": "63287583ae175fca",
+        "name": "",
+        "platform": "0144091d53bfe539",
+        "tools": "operate_home",
+        "tool_choice": "none",
+        "conversation_id": "test example",
+        "x": 610,
+        "y": 1960,
+        "wires": [
+            [
+                "26ee7fb33da44441"
+            ]
+        ]
+    },
+    {
+        "id": "0d20cfa2bd7a00a0",
+        "type": "inject",
+        "z": "63287583ae175fca",
+        "name": "2. Smart home question",
+        "props": [
+            {
+                "p": "lights",
+                "v": "[\"bathroom\", \"kitchen\"]",
+                "vt": "json"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 220,
+        "y": 1960,
+        "wires": [
+            [
+                "dd7ca9ae9b5a3e99"
+            ]
+        ]
+    },
+    {
+        "id": "e80e71a1321731c0",
+        "type": "inject",
+        "z": "63287583ae175fca",
+        "name": "4. Clear Chat History",
+        "props": [
+            {
+                "p": "clearChatHistory",
+                "v": "true",
+                "vt": "bool"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 450,
+        "y": 2100,
+        "wires": [
+            [
+                "c2a53eff4506daf9"
+            ]
+        ]
+    },
+    {
+        "id": "2f3c668301d9dd35",
+        "type": "template",
+        "z": "63287583ae175fca",
+        "name": "",
+        "field": "payload",
+        "fieldType": "msg",
+        "format": "json",
+        "syntax": "mustache",
+        "template": "{\n    \"user\": \"What is your name\",\n    \"system\": \"your name is ke and you control my smart home\"\n}",
+        "output": "json",
+        "x": 400,
+        "y": 1880,
+        "wires": [
+            [
+                "c2a53eff4506daf9"
+            ]
+        ]
+    },
+    {
+        "id": "dd7ca9ae9b5a3e99",
+        "type": "template",
+        "z": "63287583ae175fca",
+        "name": "",
+        "field": "payload",
+        "fieldType": "msg",
+        "format": "json",
+        "syntax": "mustache",
+        "template": "{\n    \"user\": \"What lights are on?\",\n    \"system\": \"The {{lights}} lights are on in the home\"\n}",
+        "output": "json",
+        "x": 420,
+        "y": 1960,
+        "wires": [
+            [
+                "c2a53eff4506daf9"
+            ]
+        ]
+    },
+    {
+        "id": "1a95ff1229b2200c",
+        "type": "inject",
+        "z": "63287583ae175fca",
+        "name": "3. Ask last",
+        "props": [],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 180,
+        "y": 2040,
+        "wires": [
+            [
+                "4996cba3fc79aecf"
+            ]
+        ]
+    },
+    {
+        "id": "4996cba3fc79aecf",
+        "type": "template",
+        "z": "63287583ae175fca",
+        "name": "",
+        "field": "payload",
+        "fieldType": "msg",
+        "format": "json",
+        "syntax": "mustache",
+        "template": "{\n    \"user\": \"What was the first question i asked?\"\n}",
+        "output": "json",
+        "x": 420,
+        "y": 2040,
+        "wires": [
+            [
+                "c2a53eff4506daf9"
+            ]
+        ]
+    },
+    {
+        "id": "fb35636977cc1eea",
+        "type": "inject",
+        "z": "63287583ae175fca",
+        "name": "5. Ask last",
+        "props": [],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 180,
+        "y": 2160,
+        "wires": [
+            [
+                "4996cba3fc79aecf"
+            ]
+        ]
+    },
+    {
+        "id": "0144091d53bfe539",
+        "type": "platform-configuration",
+        "name": "GPT 4o Model",
+        "platform": "gpt",
+        "url": "",
+        "model": "gpt-4o"
+    }
+]

package/examples/openai-call-registered-intent-example.json

@@ -0,0 +1,174 @@
+[
+    {
+        "id": "05bdf9f147f9ea58",
+        "type": "inject",
+        "z": "d312f6d5f62126f3",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "test",
+                "v": "foobar",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "",
+        "payloadType": "date",
+        "x": 240,
+        "y": 1160,
+        "wires": [
+            [
+                "937aada85a8bbdf9"
+            ]
+        ]
+    },
+    {
+        "id": "937aada85a8bbdf9",
+        "type": "OpenAI User",
+        "z": "d312f6d5f62126f3",
+        "name": "",
+        "content": "Lock up the house for me.",
+        "x": 230,
+        "y": 1200,
+        "wires": [
+            [
+                "881af854eea6f26b"
+            ]
+        ]
+    },
+    {
+        "id": "a55915b38c3e6a75",
+        "type": "OpenAI Chat",
+        "z": "d312f6d5f62126f3",
+        "name": "",
+        "token": "",
+        "model": "gpt-3.5-turbo",
+        "temperature": 0.7,
+        "max_tokens": 1200,
+        "top_p": 1,
+        "frequency_penalty": 0,
+        "presence_penalty": 0,
+        "x": 230,
+        "y": 1280,
+        "wires": [
+            [
+                "8097038c41fd6f2a"
+            ]
+        ]
+    },
+    {
+        "id": "8097038c41fd6f2a",
+        "type": "OpenAI Response",
+        "z": "d312f6d5f62126f3",
+        "name": "",
+        "x": 210,
+        "y": 1320,
+        "wires": [
+            [
+                "18324bcf3283205b"
+            ]
+        ]
+    },
+    {
+        "id": "881af854eea6f26b",
+        "type": "OpenAI System",
+        "z": "d312f6d5f62126f3",
+        "name": "",
+        "instruction": "You are a smart home assistant capable of controlling a smart home.\nIf asked a command use the appropriate function to fulfill the request.",
+        "x": 220,
+        "y": 1240,
+        "wires": [
+            [
+                "a55915b38c3e6a75"
+            ]
+        ]
+    },
+    {
+        "id": "8c97d656955c94f8",
+        "type": "Call Intent",
+        "z": "d312f6d5f62126f3",
+        "name": "",
+        "registeredNodeId": "",
+        "x": 540,
+        "y": 1320,
+        "wires": []
+    },
+    {
+        "id": "18324bcf3283205b",
+        "type": "split",
+        "z": "d312f6d5f62126f3",
+        "name": "",
+        "splt": "\\n",
+        "spltType": "str",
+        "arraySplt": 1,
+        "arraySpltType": "len",
+        "stream": false,
+        "addname": "",
+        "x": 390,
+        "y": 1320,
+        "wires": [
+            [
+                "8c97d656955c94f8"
+            ]
+        ]
+    },
+    {
+        "id": "a63ae38cd3768628",
+        "type": "debug",
+        "z": "d312f6d5f62126f3",
+        "name": "debug 45",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "true",
+        "targetType": "full",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 720,
+        "y": 1220,
+        "wires": []
+    },
+    {
+        "id": "441f8a05100623f4",
+        "type": "Register Intent",
+        "z": "d312f6d5f62126f3",
+        "name": "armHome",
+        "description": "Turn on the alarm for the house",
+        "excludeFromOpenAi": false,
+        "x": 500,
+        "y": 1220,
+        "wires": [
+            [
+                "a63ae38cd3768628"
+            ]
+        ]
+    },
+    {
+        "id": "a79bdb00f60eb779",
+        "type": "comment",
+        "z": "d312f6d5f62126f3",
+        "name": "Example: Combining Call Intent with Register Intent node",
+        "info": "You can add `Call Intent` node to the \nresponse from OpenAI. If OpenAI responds\nusing function call, then the response will\ndynamically call the correct registered node",
+        "x": 310,
+        "y": 1120,
+        "wires": []
+    },
+    {
+        "id": "50803a6c3a41949e",
+        "type": "comment",
+        "z": "d312f6d5f62126f3",
+        "name": "Register Intent nodes automatically are added to OpenAI and can be called",
+        "info": "",
+        "x": 700,
+        "y": 1180,
+        "wires": []
+    }
+]