Agent - Workflows

Agent - Workflows

This documentation provides a comprehensive guide for end users on how to create, manage, and delete Workflows and Tasks using Agent’s user interface. It includes details on required fields, options, and limitations.

Due to UI constraints, Workflows are currently only available in the desktop layout of Agent, not on mobile layouts.

Users can view all created Workflows in a list format, which provides quick access to the number of tasks associated with each workflow.

image-20251017-102923.png

Please note: The files used to test or run a Workflow must be uploaded to Agent first. It is not presently possible to upload files directly on the Task Test or File Assignment pages.

Running Workflows

Agent provides a user-friendly interface to manage Workflows efficiently. Users can select files, assign them to Tasks, and execute Workflows to process data. This documentation offers step-by-step guidance to help users navigate the Workflow system effectively.

Step 1: Select Workflow

To execute a Workflow, navigate to the 'Workflow' tab and click the 'Run' button to initiate the selected workflow

image-20251017-103019.png

Step 2: Select Files

In the file selection area, browse through the list of available files and file groups. Select the files/groups that contain information relevant to your Workflow Tasks, ensuring they provide the necessary context for the AI to process your Tasks.

Basic Task Chain

The Basic Task Chain will run each of its Tasks for each of the provided files.

image-20251017-103332.png

Basic Workflows can only be ran with up to 10 files at a time.

Flexible Workflow

The Flexible Workflow supports assigning files to individual Tasks using the matrix table.

  1. For each selected file, use the matrix table to assign it to relevant Tasks.

  2. Ensure that every Task has at least one file assigned to it.

  3. Files can be assigned to multiple Tasks if they contain information pertinent to more than one Task.

image-20251017-105345.png

 

Step 3: Run Workflow

image-20251017-104503.png

Workflow Creation

When designing a new workflow, users can choose between two types: Basic Task Chain and Flexible Workflow. Both types allow users to select an AI engine to drive the workflow's tasks.

Creating a Workflow

  1. Add a Workflow Title: Enter a descriptive title for your workflow.

image-20251017-101521.png
  1. Choose How Your Workflow Handles Tasks: Select either Basic Task Chain or Flexible Workflow (If a task exists within a workflow, the workflow type is locked and cannot be modified)

    • Basic Task Chain: Tasks run one by one, perfect for applying the same actions consistently across a set of files.

    • Flexible Workflow: Allows for different types of input and interconnected steps.

  2. Choose AI Model: Select the AI model that will process tasks (e.g., GPT 4o, o1-mini OpenAI).

  3. Create Task Sequence: Map out the actions your workflow will take. Tasks can be rearranged unless they are dependent tasks.

image-20251017-111751.png
  1. Add a Description (optional): If added here, the Description will be displayed to the users before running the Workflow.

Task Options

  • Preview: View the task details.

  • Edit: Modify the task components.

  • Delete: Remove the task (cannot delete if it is a dependent task).

Task Creation and Editing

Create/Edit Basic Task Chain

  1. Define the Task: Provide a title and instructions.

  2. Result Output: Specify the type of result output.

  3. Test: Preview the task outcome.

Create/Edit Flexible Workflow

  1. Define the Task: Provide a title, instructions, and knowledge base (Select sources for the knowledge base, result from previous task, additional information).

  2. Result Output: Specify the type of result output, Do not show the result in the final result, Additional format specifications (optional).

  3. Test: Hidden when a dependent task is chosen as the knowledge base, specifically when using "Result from Previous Task."

image-20251017-111931.png
image-20251017-112041.png
image-20251017-112215.png

 

Basic Task Chain

The Basic Task Chain is ideal for users who prefer a straightforward approach. It involves setting up a simple series of tasks that run one by one, like a checklist. Each task is performed on the documents you choose.

Required Components:

  • Title: A clear and descriptive title for the task (up to 100 characters).

  • Instructions: Detailed instructions on how the task should be carried out (up to 30,000 characters).

  • Result Output: Choose one of the following:

    • Detailed Explanation: Provides comprehensive text responses with explanations and context.

    • Numerical Value: Delivers specific numbers or quantitative data.

    • Confirmation Statement: Gives straightforward yes/no or true/false responses.

Flexible Workflow

The Flexible Workflow is designed for users who need a more customizable approach. This option allows for tasks that use different types of input and build upon each other, ideal for complex workflows involving multiple documents or interconnected steps.

Required Components:

  • Title: A clear and descriptive title for the task (up to 100 characters).

  • Instructions: Detailed instructions on how the task should be carried out (up to 30,000 characters).

  • Knowledge Base: Enhance the task's context and resources by providing (one of all should be selected):

    • Files: Use uploaded documents as context.

    • Result from Previous Task (Dependent Tasks): At least one task must be created. Incorporate outputs from earlier tasks. Note that when this option is selected, the Test section is hidden because is not supported.

    • Additional Information: Add any relevant information, if is selected then field is requaried (up to 30,000 characters).

  • Result Output: Choose one of the following:

    • Detailed Explanation

    • Numerical Value

    • Confirmation Statement

  • Do not show the result in the final result: Option to hide the task result from the final output.

  • Additional format specifications: Custom format specifications. How should the task result be presented? (optional)

Managing Workflows

Editing a Workflow (from the Workflows list)

To edit a Workflow, hover your mouse cursor over its entry in the list. The Edit (pencil) and Delete (trash can) icons will be displayed. Click on the Edit icon.

image-20250611-074739.png

Reordering Tasks in a Workflow

When managing tasks within a workflow, users can reorder tasks to optimize the sequence. However, tasks that are dependent on previous tasks must remain in the correct order to ensure proper execution.

  • Constraints:

    • Dependent tasks must be placed after their dependencies. Attempting to move a dependent task in a way that would break this constraint will result in an error message:

"You can't move this task because the dependent task must be placed after its dependencies."

Identifying Dependent Tasks

Dependent tasks within a workflow are marked with a connection icon. This icon visually indicates that the task relies on the output or results from a previous task in the sequence.

  • Connection Icon:

    • The connection icon is displayed next to dependent tasks, helping users quickly identify tasks that have dependencies.

Editing a Workflow (from the Run screen)

The upper-right of the Run Workflow screen includes an Edit Workflow button next to the Run button. Using that will present the same editing options as with using the Edit button on the Workflows list.

obraz-20250612-130126.png

Deleting a Workflow

To edit a Workflow, hover your mouse cursor over its entry in the list. The Edit (pencil) and Delete (trash can) icons will be displayed. Click on the Delete icon.

image-20250611-074851.png

A confirmation dialog will then appear.

Deleting a Workflow is irreversible.