Definition of a single named workflow an agent can run: a series of steps, similar to a journey but much simpler. Each step is just instructions for the AI, typically gathering data across a few steps and then invoking a function with it. Written as a workflow element inside the agent element.
Group: AI Agents
Properties
| Property | Returns | Description |
|---|---|---|
| instructions | String | Instructions included for every step of this workflow, in addition to each step's own instructions. |
| name | String | Portable identifier for this workflow, unique within its owning agent definition. |
| steps | List<AgentWorkflowStep> | The ordered series of steps this workflow executes. |
| title | String | Display title for this workflow. Defaults to the name when constructed without an explicit title. |
Methods
getName()
Returns: String
Portable identifier for this workflow, unique within its owning agent definition.
getTitle()
Returns: String
Display title for this workflow. Defaults to the name when constructed without an explicit title.
getInstructions()
Returns: String
Instructions included for every step of this workflow, in addition to each step's own instructions.
getSteps()
Returns: List<AgentWorkflowStep>
The ordered series of steps this workflow executes.