Build appsAdd logic and interactivityCreate actions

Create actions to interact with Sigma agents

View as Markdown

The use of AI features is subject to the following disclaimer.

Usage of this feature uses consumption credits. For details about what usage is billed, see About billable usage events.

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 explore1 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:

When an agent is run outside a workbook, such as from the home page, an automated action, or via the API, action tools run differently:

  • Action tools that require approval run without approval.
  • Some action tools cannot be run, such as action sequences that contain unavailable actions or action tools that run unavailable actions.

For a list of actions that are available when the agent is run outside a workbook, see About automated action sequences.

  1. Follow the steps to run action sequences automatically.

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

    AgentSelect an agent in the workbook.
    PromptEnter 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.
    OutputDefine 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.

  3. 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:

  1. Open the draft, a custom view, or a saved view of a workbook. If you open a saved view, go to the workbook header and click Customize this view to enable changes.

  2. 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.

  3. In the editor panel, open the Actions tab.

  4. Create a new sequence, or locate an existing sequence that you want to modify.

  5. Select the default action (if creating a new sequence), or click Add action to add a new action to the sequence.

  6. In the modal, configure the required fields to define the response:

    ActionSelect Clear chat element messages
    ElementSelect a chat element in your workbook.

If chat history is turned on for your organization, this action starts a new chat instead of clearing the current one. If chat history is turned off, the action clears the current conversation.