Skip to content

Commit ab429f7

Browse files
authored
Merge pull request #10877 from mendix/yl-ai-agent-task-documentation
Add AI Agent Task Documentation
2 parents e11ad9d + f6928dc commit ab429f7

9 files changed

Lines changed: 89 additions & 11 deletions

File tree

content/en/docs/refguide/modeling/application-logic/workflows/boundary-events.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Studio Pro now supports the following boundary event:
3333
* [Multi-user task](/refguide/multi-user-task/)
3434
* [Call microflow](/refguide/call-microflow/)
3535
* [Call workflow](/refguide/call-workflow/)
36+
* [AI agent task](/refguide/ai-agent-task/) (in Studio Pro 11.9 and above)
3637

3738
{{% alert color="info" %}}
3839
When a boundary event is added to an activity, this activity is also referred to as the parent activity of the boundary event.

content/en/docs/refguide/modeling/application-logic/workflows/workflow-elements/_index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ The elements of this category are described in the table below:
2828
| Graphic | Element | Description |
2929
| ----------------------------------------------------------- | --------------------------------- | ------------------------------------------------------------ |
3030
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/start-event.png" alt="Start Event" class="no-border" >}} | Start event | The starting point of a workflow. Workflows are triggered either by the [Call workflow](/refguide/on-click-event/#call-workflow) on-click event on pages or by the [Call workflow](/refguide/workflow-call/) activity in microflows. <br />Click the start event to open [workflow properties](/refguide/workflow-properties/). |
31-
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/annotation.png" alt="Annotation" class="no-border" >}} | Annotation | An annotation is an element that can be used to put comments to a flow. For example, you can add a comment for your team that one of the user tasks needs to be changed later. <br />You can add annotations to the workflow or to individual activities. To add the annotation to the workflow, drag and drop the annotation in the editor's working area. To add the annotation to the activity, drag and drop it inside the activity. |
32-
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/decision.png" alt="Decision" class="no-border" >}} | [Decision](/refguide/decision-in-workflows/) | Makes a choice based on a condition and follows one and only one of the outgoing paths. |
33-
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/parallel-split.png" alt="Parallel Split" class="no-border" >}} | [Parallel split](/refguide/parallel-split/) | Adds two parallel paths to your workflow. |
31+
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/annotation.png" alt="Annotation" class="no-border" >}} | Annotation | Allows you to put comments to a flow. For example, you can add a comment for your team that one of the user tasks needs to be changed later. <br />You can add annotations to the workflow or to individual activities. To add the annotation to the workflow, drag and drop the annotation in the editor's working area. To add the annotation to the activity, drag and drop it inside the activity. |
32+
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/decision.png" alt="Decision" class="no-border" >}} | [Decision](/refguide/decision-in-workflows/) | Allows you to make a choice based on a condition and follows one and only one of the outgoing paths. |
33+
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/parallel-split.png" alt="Parallel Split" class="no-border" >}} | [Parallel split](/refguide/parallel-split/) | Allows you to create parallel paths that execute activities concurrently. By default, two paths are added. |
3434
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/jump.png" alt="Jump Activity" class="no-border" >}} | [Jump](/refguide/jump-activity/) | Allows you to jump to other activities in the workflow. |
3535
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/wait-for-notification.png" alt="Wait for notification activity" class="no-border" >}} | [Wait for notification](/refguide/wait-for-notification/) | Allows you to suspend a workflow’s execution until the workflow is notified. |
3636
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/end-event.png" alt="End event" >}} | [End event](/refguide/end-event-in-workflows/) | Ends the path of the workflow. |
@@ -47,8 +47,9 @@ The elements of this category are described in the table below:
4747

4848
| Graphic | Element | Description |
4949
| ----------------------------------------------------------- | --------------------------------- | ------------------------------------------------------------ |
50-
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/user-task.png" width="50px" alt="User Task" class="no-border" >}} | [User task](/refguide/user-task/) | A central element in a workflow that allows you to assign a task to a certain user or a group of users using filters or microflows. |
51-
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/multi-user-task.png" width="50px" alt="Multi-user task" class="no-border" >}} | [Multi-user task](/refguide/multi-user-task/) | A central element in a workflow that allows you assign a task to multiple users. Each user performs the same task. The outcomes from all individual tasks will be aggregated into a single multi-user task outcome based on the [completion condition](/refguide/multi-user-task/#completion-condition). |
50+
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/user-task.png" width="50px" alt="User Task" class="no-border" >}} | [User task](/refguide/user-task/) | Allows you to assign a task to a certain user or a group of users using filters or microflows. |
51+
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/multi-user-task.png" width="50px" alt="Multi-user task" class="no-border" >}} | [Multi-user task](/refguide/multi-user-task/) | Allows you assign a task to multiple users. Each user performs the same task. The outcomes from all individual tasks will be aggregated into a single multi-user task outcome based on the [completion condition](/refguide/multi-user-task/#completion-condition). |
52+
| {{< figure src="/attachments/refguide/modeling/application-logic/workflows/workflow-elements/ai-agent-task.png" width="50px" alt="AI agent task" >}} | [AI agent task](/refguide/ai-agent-task/) | Allows you to call an [AI agent](/refguide/ai-agent-task/#ai-agents) to complete a task such as classification, summarization, or content generation. |
5253

5354
## Events {#events}
5455

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: "AI Agent Task"
3+
url: /refguide/ai-agent-task/
4+
weight: 85
5+
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details. The anchor {#ai-agents} is also used in the product.
6+
---
7+
8+
## Introduction
9+
10+
**AI agent task** lets you assign a task to an AI agent as a step in your workflow, instead of assigning that step to a human.
11+
12+
When the workflow reaches the AI agent task, a microflow is called to handle the execution of an agent that performs a predefined task. The workflow then continues based on that result, for example, by routing to the next step, triggering an action, or escalating to a human reviewer.
13+
14+
**AI agent task** can be used across a wide range of use cases. Some examples include assessing requests, classifying data, extracting information from unstructured text, summarizing content, and drafting outputs such as notifications or reports.
15+
16+
## AI Agents {#ai-agents}
17+
18+
An AI agent is an autonomous software system powered by large language models (LLMs). It perceives its environment, reasons through a goal, and takes actions to achieve the goal, replacing repetitive manual steps. For critical tasks, you can still add a user task to keep a human in the loop.
19+
20+
With **AI agent task**, you can select a [microflow](#microflow) that calls any agent that has been configured in your application. You are not limited to one approach. Agents can be created and configured in different ways, as long as they can be called via a microflow.
21+
22+
If you do not yet have any agents configured, you can get started by following the guide on [creating your first agent](/appstore/modules/genai/how-to/howto-single-agent/).
23+
24+
{{% alert color="info" %}}
25+
Support for configuring AI agents using an Agent Editor in Studio Pro is coming soon.
26+
{{% /alert %}}
27+
28+
## Properties
29+
30+
AI agent task properties consist of the following sections:
31+
32+
* [General](#general)
33+
* [Parameters](#parameters)
34+
* [Outcomes](#outcomes)
35+
* [Boundary events](#boundary-events)
36+
* [Common](#common)
37+
38+
### General Section {#general}
39+
40+
#### Caption
41+
42+
The **Caption** describes what happens in this element. It is displayed under the workflow element to make the workflow easier to read and understand.
43+
44+
#### Microflow {#microflow}
45+
46+
The microflow that handles the AI agent execution for the AI agent task. Use it to prepare and pass the right information to the agent, call the agent, and define what happens next.
47+
48+
### Parameters {#parameters}
49+
50+
Parameters of the selected microflow. Depending on the selected microflow, you will see a list of its parameters. Parameters pass data to the element. To view the **Parameters**, click the ellipsis icon next to the property name.
51+
52+
### Outcomes {#outcomes}
53+
54+
The outcomes depend on the return type of the selected microflow:
55+
56+
* **No return type**: The activity has a single outcome and the workflow proceeds to the next step.
57+
* **Boolean**: The activity has two outcomes: `true` and `false`. The workflow proceeds to the next step based on the returned value.
58+
* **Enumeration**: The activity has one outcome for each enumeration value, plus an `empty` outcome for when the value is unassigned. The workflow proceeds to the next step based on the returned value.
59+
60+
### Boundary Events Section {#boundary-events}
61+
62+
Boundary events can be attached to this element and are triggered by certain events to handle exceptional situations during its execution. For more information, see [Boundary Events](/refguide/workflow-boundary-events/).
63+
64+
### Common Section {#common}
65+
66+
**Name** is the internal name of the element. When referring to the element in the app, you will use this name. It must be unique within the workflow, but you can have two elements with the same name in different workflows.
67+
68+
## Read More
69+
70+
* [Workflow Properties](/refguide/workflow-properties/)
71+
* [GenAI Capabilities in Mendix](/appstore/modules/genai/)
72+
* [Create Your First Agent](/appstore/modules/genai/how-to/howto-single-agent/)

content/en/docs/refguide/modeling/application-logic/workflows/workflow-elements/call-microflow.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,15 @@ Parameters of the selected microflow. Depending on the selected microflow, you w
3636

3737
### Outcomes Section {#outcomes}
3838

39-
**Outcomes** depends on the return type and values of the microflow. For example, when there is not return type, you have a single outcome; for the Boolean, you have **true** and **false** outcomes; and for the enumeration – an outcome per each enumeration value and an empty one when the value is unassigned.
39+
The outcomes depend on the return type of the selected microflow:
40+
41+
* **No return type**: The activity has a single outcome and the workflow proceeds to the next step.
42+
* **Boolean**: The activity has two outcomes: `true` and `false`. The workflow proceeds to the next step based on the returned value.
43+
* **Enumeration**: The activity has one outcome for each enumeration value, plus an `empty` outcome for when the value is unassigned. The workflow proceeds to the next step based on the returned value.
4044

4145
### Boundary Events Section {#boundary-events}
4246

43-
For more information, see [Boundary Events](/refguide/workflow-boundary-events/).
47+
Boundary events can be attached to this element and are triggered by certain events to handle exceptional situations during its execution. For more information, see [Boundary Events](/refguide/workflow-boundary-events/).
4448

4549
### Common Section {#common}
4650

content/en/docs/refguide/modeling/application-logic/workflows/workflow-elements/call-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ To change the parameter, either double-click the parameter from the list or sele
4848

4949
### Boundary Events Section {#boundary-events}
5050

51-
For more information, see [Boundary Events](/refguide/workflow-boundary-events/).
51+
Boundary events can be attached to this element and are triggered by certain events to handle exceptional situations during its execution. For more information, see [Boundary Events](/refguide/workflow-boundary-events/).
5252

5353
### Common Section {#common}
5454

content/en/docs/refguide/modeling/application-logic/workflows/workflow-elements/multi-user-task.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ In addition to adding new parameters, you can perform the following actions on p
401401

402402
### Boundary Events Section {#boundary-events}
403403

404-
For more information, see [Boundary Events](/refguide/workflow-boundary-events/).
404+
Boundary events can be attached to this element and are triggered by certain events to handle exceptional situations during its execution. For more information, see [Boundary Events](/refguide/workflow-boundary-events/).
405405

406406
### Common Section {#common}
407407

content/en/docs/refguide/modeling/application-logic/workflows/workflow-elements/user-task.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ In addition to adding new parameters, you can perform the following actions on p
200200

201201
### Boundary Events Section {#boundary-events}
202202

203-
For more information, see [Boundary Events](/refguide/workflow-boundary-events/).
203+
Boundary events can be attached to this element and are triggered by certain events to handle exceptional situations during its execution. For more information, see [Boundary Events](/refguide/workflow-boundary-events/).
204204

205205
### Common Section {#common}
206206

content/en/docs/refguide/modeling/application-logic/workflows/workflow-elements/wait-for-notification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The **Caption** describes what happens in this element. It is displayed under th
3131

3232
### Boundary Events {#boundary-events}
3333

34-
For more information, see [Boundary Events](/refguide/workflow-boundary-events/).
34+
Boundary events can be attached to this element and are triggered by certain events to handle exceptional situations during its execution. For more information, see [Boundary Events](/refguide/workflow-boundary-events/).
3535

3636
### Common Section {#common}
3737

3.58 KB
Loading

0 commit comments

Comments
 (0)