Activities

❗️

This is only applicable to the new Agent Studio > Plugin Workspace

What is an activity?

A type of process block that represents an "activity" in a business process. This is typically either taking action in a system or surfacing information.

Activities & Control Flow blocks work hand-in-hand to create conversation plugins that conform to your business processes.

Types of activities

Action Activities

Action Activities can call HTTP, Script, Built-in, or Compound Actions to fetch or update data in your business systems.

An Action Activity includes the following configuration:

  • Select an action - This is the action you will be running in this Activity block. It will be a dropdown of all available actions (HTTP, Script, Built-in, Compound) you have configured in your Agent Studio instance.
    • Note: Compound Actions should not be used in the middle of a Plugin process. This is because they are asynchronous in nature so they will not return data back to the Plugin. Instead, they return "progress updates" back to the user during execution.
  • Required slots - This defines which slots are required to run this Activity. You can select existing or create a new slot here. This important because it tells the AI Assistant when it should ask the user for values.
  • Input Mapper - This is a JSON Bender that allows you to map data (slots or outputs from previous Activities) to the inputs for your action.
  • Output Mapper - This represents the output object of your Activity. By default, it will capture all of the data that the action you selected returns. However, you can "dot walk" into the object if you want to limit the data returned.
    • Clicking "Switch to advanced bender" will take you to a JSON Bender editor where you have more controls to fully define a custom output object.
  • Output Key - This is a keyword that represents the output of the Activity. You can see how to reference outputs here.
  • Activity Parameters - These are settings for the Activity

Activity Confirmation Policy

  • User consent required before execution? - This requires the plugin to ask for user consent and give them the option of editing any of their inputs before executing the plugin.

    📘

    Agentic Automation Engine 1.0

    If you're on the version of the Agentic Automation Engine that predates our April release, then you can set this as Plugin-level setting on your Plugin settings page.

Content Activities

Content activities share articles, forms, or markdown text with users.

Content activities do not require inputs to run. They do not produce data.

Dynamically Referencing Data In Text Content Activity

To reference data from the data bank in a content activity you can reference the key directly inside of a double bracket or "Mustache syntax" example-> {{ticket_number}}. You do not need to use the "data." key as we are pointing directly to the entire data bank when inside of a text activity. You can reference anything that has been output by a previous action or previously collected slot.

To reference a specific index in an array, use a dot (.) as an accessor. This allows you to directly access the element at the specified index. For example, to access the first element of an array associated with the key "ticket_list", you should use: ticket_list.0

Example:
Suppose you have the following JSON structure:

{  
  "ticket_list": ["ticket1", "ticket2", "ticket3"]  
}

To access "ticket1", you would use the notation: ticket_list.0

  • DSL syntax does not work inside this mustache syntax only simple references to keys
  • You can only reference strings with the mustache syntax you can not reference arrays or objects