insights.message
- 14 Apr 2023
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
insights.message
- Updated on 14 Apr 2023
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Description
Toggles a message insight that persists for the lifetime of an app.
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| key | Text | Yes | Unique identifier for insight |
| on | Boolean | Yes | Visibility toggle (true = show, false = hide) |
| [category] | Text | No | Category to group insight within |
| [message] | Text | No | Insight message |
Returns
No return value.
Examples
// show a message insight to the user
ai.insights.message("insight1", true, "Testing", "Consider echo.");
// hide (remove) a message insight
ai.insights.message("insight1", false);
Remarks
Use this function to display message-based insights to an attached intelligence experience.
Tip
Dr. Know products support insights using an Insights Panel.