Hero AI Companion
The Hero AI Companion is Swimlaneβs agentic AI chat experience in Turbine. Use it to ask questions about records, reports, and cybersecurity topics in natural language.
The companion uses one panel across Turbine. On most screens you get the general companion; on a playbook or component canvas you get Playbook Building Mode or Component Building Mode instead. See Hero AI Modes and Context or the Hero AIHero AI overview.
The Hero AI Companion is behind a feature flag and must be enabled. To enable this feature, contact Swimlane Support. Once enabled, the Hero AI icon appears at the top-right corner of the screen.
Choose Your Path
I want to⦠| Go to |
|---|---|
Open and use the chat panel | |
Clear the current chat without closing the panel | |
Control what data Hero can read | |
Understand companion vs building modes | |
Build or change playbook flows with AI | Create and Modify Playbooks with Hero AICreate and Modify Playbooks with Hero AI |
See what the Playbook Generator Agent can do | Playbook Generator Agent ReferencePlaybook Generator Agent Reference |
Build or change a component on the canvas with AI | Create and Modify Components with Hero AICreate and Modify Components with Hero AI |
Build or change a widget with AI | Build Widgets with Hero AIBuild Widgets with Hero AI |
Run a component from chat (not edit the canvas) | How Hero AI Executes ComponentsHow Hero AI Executes Components |
Send feedback on a response |
If you are viewing an application record, Hero recognizes record context so you can ask about "this case," "this user," or "this host."
The general companion can read application records. It cannot update playbook or component canvas layouts from the main toolbar chat alone. To edit a playbook flow or component on the canvas, use the matching Building Mode (see below).
Hero AI Modes and Context
Hero AI uses one panel across Turbine. The mode depends on which screen you are on, not on a separate setting you turn on in the menu.
Where you are | Hero AI mode | What it does |
|---|---|---|
Most screens (records, reports, Components list, and so on) | General companion | Questions about tenant data, records, reports, cybersecurity topics; can run components marked Visible to Hero AI (see How Hero AI Executes ComponentsHow Hero AI Executes Components) |
Playbook open in the canvas editor | Playbook Building Mode | Create or modify flows with the Playbook Generator Agent β Create and Modify Playbooks with Hero AICreate and Modify Playbooks with Hero AI |
Component open in the Component Builder | Component Building Mode | Create or modify the component on the canvas β Create and Modify Components with Hero AICreate and Modify Components with Hero AI |
Widget editor open (record or report widget) | Widget Building Mode | Edit widget Code with the widget builder agent β Build Widgets with Hero AIBuild Widgets with Hero AI |
How Mode Changes When You Navigate
- Open Hero AI from the toolbar on any screen β you start in (or return to) the general companion unless you are already inside a playbook, component, or widget editor.
- Open a playbook, component, or widget in the editor and open Hero AI (toolbar, Build with Hero AI, or Start building with Hero AI on an empty playbook) β the panel enters Playbook Building Mode, Component Building Mode, or Widget Building Mode. You should see a banner such as Entered Playbook Building Mode, Entered Component Building Mode, or Entered Widget Building Mode, and a footer label with the same name.
- Navigate away from that editor (for example, back to the Components list or Playbooks list) β canvas context clears and the panel returns to the general companion welcome (for example, Hello! How can I help you today?). You do not need to close and reopen Hero AI.
Playbook Building Mode, Component Building Mode, and Widget Building Mode are for editing automation or widget code on the canvas. How Hero AI Executes Components describes running published components from the general companion when Visible to Hero AI is enabled β not editing the component definition.
See the Hero AI Companion in action in this demo video.
Open the Hero AI Companion
- Click the Hero AI icon at the top-right of the screen.
- The Hero AI panel opens on the right (docked) or full screen, depending on your last layout choice.
- Type a question in the input area and send it.
Hero AI Companion Panel Controls
The panel header shows Hero AI and action icons on the right.
Control | Icon / location | What it does |
|---|---|---|
Maximize chat / Minimize chat | Expand or collapse icon | Switches between docked (right side) and full-screen layout. |
More options | Vertical ellipsis (three dots) | Opens a menu with additional actions. |
End chat | X | Closes the companion panel. |
Reset Conversation History
Use Reset conversation history when you want a new chat in the same open panel without closing Hero AI.
- Open the Hero AI panel.
- Click the More options menu (vertical ellipsis) in the panel header.
- Click Reset conversation history.
Hero clears the visible messages and starts a new conversation. Any in-flight request is canceled so it does not affect the new chat.
Reset conversation history is not the same as closing the panel. End chat (X) closes the panel and also clears history when you reopen it. Reset conversation history clears the thread while the panel stays open.
On a playbook or component canvas, reset also starts a fresh session for Playbook Building Mode or component building (history and session context are cleared).
Uses of the Hero AI Companion
Efficient Record Access
Hero AI reduces manual filtering by letting you ask direct questions about tenant data. Responses can include links to records or pages so you can open the exact item in the UI.
Record Context
When you view an application record, Hero uses that record as context. You can ask questions about the current case, user, host, or other fields on the record.
Conversations and Context Window
The companion keeps context for follow-up questions (for example, "give me a shorter answer" or "tell me more about those cases"). Context is typically limited to the most recent five prompts and responses to manage token use.
Action | Effect on conversation |
|---|---|
Reset conversation history (menu) | Clears messages and starts a new thread; panel stays open. |
End chat (X) | Closes the panel; history is cleared. |
Refresh the browser page | History is cleared. |
Leave a playbook or component canvas editor | Panel can stay open; mode returns to the general companion (building banners clear). |
Navigate to another screen (still in general companion) | Panel can stay open; chat history usually continues until you reset, close, or refresh. |
Large Result Sets and Reports
When a response matches many records, Hero shows a preview (up to five records) and the total count. A link can open a full report in the Swimlane UI with the same filters applied. You can sort, export, or save that report like any other report view.
RBAC
The Hero AI Companion inherits the RBAC settings of the user chatting with Hero. If a user cannot read an application or field, Hero cannot use that application or field in answers.
Hero AI Companion Windows
The companion supports two layouts:
Mode | Description |
|---|---|
Full-screen mode | Occupies the entire screen; suited to longer sessions. |
Docked mode | Panel on the right side; suited to multitasking and record context. |
Use Maximize chat or Minimize chat in the panel header to switch layouts.
Configure Hero AI Visibility Settings
Application and field visibility control which data Hero can access when answering questions.
- Enable visibility on an application or field so Hero can use it in answers.
- Disable visibility to restrict Hero from that data even if the user can read it in the UI.
Configure Applications
Configure whether an application is visible to Hero AI from App Settings. For new applications, Visible to Hero AI is on by default. When the toggle is on, the Description field is required so Hero understands the application purpose.
Use this pattern for application descriptions:
The [Application Name] ([Application Acronym]) application is designed to [purpose]. It contains information about [data stored]. Each record in [Acronym] includes [main fields and formats]. This application is commonly used to [use case]. [Terminology specific to this application.]
Example (Case and Incident Management):
The Case and Incident Management (CIM) application supports Security Operations Center (SOC) operations. It stores case records investigated by analysts, including status, priority, severity, users, hosts, assets, observables, and determination. Analysts often work oldest cases first (First Created), highest Priority (P0 is highest), highest Severity (Critical is highest), and open status (New).
Turn On Visible to Hero AI for an Application
- Navigate to APPLICATIONS & APPLETS and open Create a New Application, or open an existing application App Settings.
- In Create Application or App Settings, set Visible to Hero AI to on (default for new applications).
- Enter a Description (required when visibility is on).
- Save the application.
If Visible to Hero AI is off for an application, you cannot turn it on for individual fields in that application.
Configure Fields
Configure field visibility from Field Properties on the form layout. By default, fields are not visible to Hero AI. When you turn visibility on, Description is required.
Good field descriptions are one short sentence with meaning and sample values when helpful.
Example:
The primary CVE ID of the vulnerability. Value format: CVE-YYYY-XXXXX. Sample value: CVE-2019-12345.
Turn On Visible to Hero AI for a Field
- In Form Layout, select the field.
- In Field Properties, turn on Visible to Hero AI.
- Enter a Description (required when visibility is on).
Visibility Logic Table
Application Visible to Hero AI | Field Visible to Hero AI | Hero AI can use the field |
|---|---|---|
On | On | Yes |
On | Off | No |
Off | On | No |
Off | Off | No |
Thumbs Up/Down Functionality and Feedback Options
Use the thumbs up and thumbs down icons under each reply to send feedback.
Thumbs Up β Positive Feedback
Click thumbs up when the response:
- Answers your question accurately
- Is helpful, clear, or complete
- Matches the expected format or logic
Thumbs Down β Negative Feedback
Click thumbs down when the response:
- Is partially correct, incorrect, or irrelevant
- Is hard to understand because of formatting
- Does not match the context or logic of your request
After thumbs down, a feedback panel appears with options:
Option | When to use it |
|---|---|
Partially Correct | Some information is useful but incomplete or has minor issues. |
Incorrect Answer | The response is wrong or does not apply. |
Irrelevant | The response does not address your prompt. |
Poor Formatting | The answer is hard to read (for example, broken code blocks). |
You can add notes in Additional Feedback. By default, Include last prompt and response is checked so reviewers see full context.
Use Case Example
You ask: "Can you filter applications created in the last two days?"
Hero AI replies with SQL that uses syntax your environment does not support.
You click thumbs down, select Incorrect Answer, add a note (for example, "Use DATE_SUB() for MySQL. Clarify created_at field type."), leave Include last prompt and response checked, and click Submit.
See Also
- Create and Modify Playbooks with Hero AICreate and Modify Playbooks with Hero AI
- Create and Modify Components with Hero AICreate and Modify Components with Hero AI
- How Hero AI Executes ComponentsHow Hero AI Executes Components
- ComponentsComponents
- Hero AIHero AI β overview of all Hero AI features