Create actions to interact with Sigma agents (Beta)

🚩
This documentation describes one or more public beta features that are in development. Beta features are subject to quick, iterative changes; therefore the current user experience in the Sigma service can differ from the information provided in this page.
This page should not be considered official published documentation until Sigma removes this notice and the beta flag on the corresponding feature(s) in the Sigma service. For the full beta feature disclaimer, see Beta features.

Workbooks support actions that interact with Sigma agents. You can automatically run an agent to perform a specific task, or clear the current conversation with an agent in a chat element.

🚩
You cannot call an agent with a manual action trigger (such as clicking a button), and can only automatically run an agent on a schedule.

This document explains how to create actions that interact with Sigma agents. For more information about actions in Sigma, see Intro to actions.

User requirements

The ability to create and manage actions that interact with Sigma agents and the chat element requires the following:

You must be assigned an account type with the Full explore or Create, edit, and publish workbook permissions enabled.
You must be the workbook owner or be granted Can explore¹ or Can edit workbook access.

1If you’re granted Can explore workbook access, you can configure actions in custom, saved, and shared views. Actions configured in views or saved views do not apply to the workbook’s published version.

Call an agent from an automated action

Create an action that calls a Sigma agent from an automated action:

Follow the steps to run action sequences automatically.

In the action configuration popover, select the Call agent action:


Agent	Select an agent in the workbook.
Prompt	Enter a prompt to send to the agent when the action runs. Include enough details to make sure that the agent can produce desired results without follow-up questions. You can test your prompt in the chat element.
Output	Define action variables to structure the output from the agent. By default, the `Agent-response` action variable is defined to make the entire response of the agent available as text. Click + Add variable to further structure the output. The agent uses instructions in the prompt and the name of the action variables when structuring output.

After configuring the action, finish setting up the automated action sequence.

For a complete example, see Example: Nightly usage summary agent.

Clear chat element messages from an action

Create an action that clears the conversation with an agent in a chat element:

Open the draft, custom view, or saved view of a workbook.
Select the trigger element (the element users must interact with to initiate the action).

If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.
In the editor panel, open the Actions tab.
Create a new sequence, or locate an existing sequence that you want to modify.
Select the default action (if creating a new sequence), or click Add action to add a new action to the sequence.
In the modal, configure the required fields to define the response:

Action Select Clear chat element messages
Element Select a chat element in your workbook.