FlowFuse Expert Document for Chat Interface#6779
FlowFuse Expert Document for Chat Interface#6779sumitshinde-84 wants to merge 3 commits intomainfrom
Conversation
101e53f to
f053b2d
Compare
|
@Steve-Mcl Could you please review this PR ? |
|
|
||
| # Chat Interface | ||
|
|
||
| The FlowFuse Expert chat interface is your conversational AI companion that you can open directly in the Node-RED editor. While other FlowFuse Expert features (like inline code completions and flow generation) work passively in the background, the chat interface is where you actively engage the AI - asking questions, exploring your flows, and gaining insights from your live data. |
There was a problem hiding this comment.
| The FlowFuse Expert chat interface is your conversational AI companion that you can open directly in the Node-RED editor. While other FlowFuse Expert features (like inline code completions and flow generation) work passively in the background, the chat interface is where you actively engage the AI - asking questions, exploring your flows, and gaining insights from your live data. | |
| The FlowFuse Expert chat interface is your conversational AI companion that you can open directly in the Node-RED editor. While other FlowFuse Expert features (like inline code completions and next-node prediction) work passively in the Node-RED Editor, the chat interface is where you actively engage the AI - asking questions, exploring your flows, and gaining insights from your live data. |
| - "How do I parse a JSON payload in a Function node?" | ||
| - "Explain what this flow is doing" | ||
| - "Why is this node outputting a number instead of a string?" | ||
| - "Is the `node-red-contrib-mqtt-broker` node installed on this instance?" |
There was a problem hiding this comment.
| - "Is the `node-red-contrib-mqtt-broker` node installed on this instance?" | |
| - "Is `node-red-contrib-string` node installed on this instance?" |
I would not use a node we dont recommend.
| **Support mode** is for flow-building assistance. Use it when you need help understanding, building, or debugging your Node-RED flows. In this mode, the Expert draws on its knowledge of Node-RED, your installed palette, and the context of your current flows to answer questions and provide guidance. | ||
|
|
||
| Typical use cases in Support mode: | ||
| - "How do I parse a JSON payload in a Function node?" |
There was a problem hiding this comment.
| - "How do I parse a JSON payload in a Function node?" | |
| - "How do I convert data to CSV for writing to file & do you have any flow examples?" |
Something like this shows off flow import feature.
I dont think we should encourage people to generate JavaSript in the expert (just yet) - we prefer them to use assistant in the editor (i.e. inline completions or the Function Builder"
| This allows you to ask questions like: | ||
| - "What does this flow do?" | ||
| - "Why does this flow output a number instead of a string?" | ||
| - "Which flows connect to the MQTT broker node?" |
There was a problem hiding this comment.
This one is not really of use. the broker is a config node and does not "connect" via visual wires
I would recomend dropping this one
| - "Which flows connect to the MQTT broker node?" |
| - "What does this flow do?" | ||
| - "Why does this flow output a number instead of a string?" | ||
| - "Which flows connect to the MQTT broker node?" | ||
| - "Is there anything in this flow that could cause message loss?" |
There was a problem hiding this comment.
| - "Is there anything in this flow that could cause message loss?" | |
| - "Is there something wrong with this flow? I don't seem to get an output from the debug node!" |
| - "What is the current status of production line 3?" | ||
| - "Query the database and show me the last 10 error events" | ||
| - "Summarize today's sensor readings from the MQTT broker" |
There was a problem hiding this comment.
| - "What is the current status of production line 3?" | |
| - "Query the database and show me the last 10 error events" | |
| - "Summarize today's sensor readings from the MQTT broker" | |
| - You have an MCP Resource named `production_lines_facilities_list` that returns a list of your production lines, their facility names and the facility types (stamping, assembly, packaging etc) | |
| - You can ask: "List all stamping facilities on our production lines" | |
| - You have added an MCP Tool named `get_production_live_state` | |
| -You can ask: "Tell me which of any of my assembly facilities are running and at what speed" | |
| - You have added an MCP tool named `get_production_oee` that | |
| - You can ask: "Show me the worst 3 OEE results for all production line facilities" |
I think a more cohesive story might be better here - something that tells a story of possibilities?
| | "What does this mean?" | "What does this log entry mean?" | | ||
| | "Why did this happen?" | "Why did this error log occur?" | |
There was a problem hiding this comment.
nitpick
We have not published the debug long capability (tho it is very close - likely landing tomorrow)
If we are including debug log context, we should also mention it in the earlier sections (around Line 99)
|
|
||
| ### Ask one question at a time for complex topics | ||
|
|
||
| If you have multiple questions, consider asking them separately so the Expert can give a focused answer to each rather than a broad response that covers everything superficially. |
There was a problem hiding this comment.
Maybe include a line like about context poisoning and using the "Start Over" button?
Description
This PR creates separate documentation for FlowFuse Expert. It adds a parent FlowFuse Expert section with two documents: one for the Chat Interface and another for the AI features in Node-RED, such as Flow Completion and the Function Builder.
Related Issue(s)
Checklist
flowforge.yml?FlowFuse/helmto update ConfigMap TemplateFlowFuse/CloudProjectto update values for Staging/ProductionLabels
area:migrationlabel