mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Peter Ibekwe
6086a74302
* Promote agent-framework-declarative package to RC * Update missed package status file.
74 lines
1.6 KiB
Markdown
74 lines
1.6 KiB
Markdown
# Declarative Workflows
|
|
|
|
Declarative workflows allow you to define multi-agent orchestration patterns in YAML, including:
|
|
- Variable manipulation and state management
|
|
- Control flow (loops, conditionals, branching)
|
|
- Agent invocations
|
|
- Human-in-the-loop patterns
|
|
|
|
See the [main workflows README](../README.md#declarative) for the list of available samples.
|
|
|
|
## Prerequisites
|
|
|
|
```bash
|
|
pip install agent-framework-declarative
|
|
```
|
|
|
|
## Running Samples
|
|
|
|
Each sample directory contains:
|
|
- `workflow.yaml` - The declarative workflow definition
|
|
- `main.py` - Python code to load and execute the workflow
|
|
- `README.md` - Sample-specific documentation
|
|
|
|
To run a sample:
|
|
|
|
```bash
|
|
cd <sample_directory>
|
|
python main.py
|
|
```
|
|
|
|
## Workflow Structure
|
|
|
|
A basic workflow YAML file looks like:
|
|
|
|
```yaml
|
|
name: my-workflow
|
|
description: A simple workflow example
|
|
|
|
actions:
|
|
- kind: SetValue
|
|
path: turn.greeting
|
|
value: Hello, World!
|
|
|
|
- kind: SendActivity
|
|
activity:
|
|
text: =turn.greeting
|
|
```
|
|
|
|
## Action Types
|
|
|
|
### Variable Actions
|
|
- `SetValue` - Set a variable in state
|
|
- `SetVariable` - Set a variable (.NET style naming)
|
|
- `ResetVariable` - Clear a variable
|
|
|
|
### Control Flow
|
|
- `If` - Conditional branching
|
|
- `ConditionGroup` - Multi-way branching
|
|
- `Foreach` - Iterate over collections
|
|
- `GotoAction` - Jump to labeled action
|
|
|
|
### Output
|
|
- `SendActivity` - Send text/attachments to user
|
|
|
|
### Agent Invocation
|
|
- `InvokeAzureAgent` - Call an Azure AI agent
|
|
|
|
### Tool Invocation
|
|
- `InvokeFunctionTool` - Call a registered Python function
|
|
|
|
### Human-in-Loop
|
|
- `Question` - Request user input
|
|
- `RequestExternalInput` - Request external data/approval
|