mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Eduard van Valkenburg
a2856d3b92
* restructure: Python samples into progressive 01-05 layout - 01-get-started/: 6 numbered steps (hello agent → hosting) - 02-agents/: all agent concept samples (tools, middleware, providers, etc.) - 03-workflows/: ALL existing workflow samples preserved as-is - 04-hosting/: azure-functions, durabletask, a2a - 05-end-to-end/: demos, evaluation, hosted agents - Old files moved to _to_delete/ for review - Added AGENTS.md with structure documentation - autogen-migration/ and semantic-kernel-migration/ preserved at root * fix: switch to AzureOpenAI Foundry, fix CI failures - Switch all 01-get-started samples to AzureOpenAIResponsesClient with Azure AI Foundry project endpoint (AZURE_AI_PROJECT_ENDPOINT + AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME + AzureCliCredential) - Add _to_delete/ and 05-end-to-end/ to pyrightconfig.samples.json excludes - Fix test paths in packages/ that referenced old getting_started/ dirs: durabletask conftest + streaming test, azurefunctions conftest, devui conftest + capture_messages + openai_sdk_integration - Fix workflow_as_agent_human_in_the_loop.py import (sibling import) - Update hosting READMEs and tool comment paths - Replace root README.md with new structure overview - Update AGENTS.md to document Azure OpenAI Foundry as default provider * cleanup: remove _to_delete folder, copy resource files to active dirs All files in _to_delete/ were either: - Exact duplicates of files in the new structure (240 files) - Same file with only comment path updates (100 files) - One import-fix diff (workflow_as_agent_human_in_the_loop.py) - One superseded minimal_sample.py Resource files (sample.pdf, countries.json, employees.pdf, weather.json) copied to 02-agents/sample_assets/ and 02-agents/resources/ since active samples reference them. * fix: address PR review comments, centralize resources, remove root duplicates - Fix type annotation in 04_memory.py (string union -> proper types) - Fix old sample paths in observability files - Fix grammar/spelling in observability samples - Move sample_assets/ and resources/ to shared/ folder - Remove 8 duplicate observability files from 02-agents root - Update resource path references in multimodal_input and provider samples * fix: update broken links from old getting_started paths to new structure - Update relative paths in READMEs: getting_started/ → 01-get-started/, 02-agents/, 03-workflows/, 04-hosting/, 05-end-to-end/ - Fix absolute GitHub URLs in package READMEs - Fix broken link in ollama package README * fix: convert absolute GitHub URLs to relative paths for link checker Absolute URLs to python/samples/ on main branch 404 until PR merges. Converted to relative paths that linkspector can verify locally. * fix: update link for handoff sample moved to orchestrations/ * fix: update chatkit-integration README path from demos/ to 05-end-to-end/ * fix: update broken links in orchestrations README to match flat directory structure
75 lines
1.7 KiB
Markdown
75 lines
1.7 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)
|
|
- `AppendValue` - Append to a list
|
|
- `ResetVariable` - Clear a variable
|
|
|
|
### Control Flow
|
|
- `If` - Conditional branching
|
|
- `Switch` - Multi-way branching
|
|
- `Foreach` - Iterate over collections
|
|
- `RepeatUntil` - Loop until condition
|
|
- `GotoAction` - Jump to labeled action
|
|
|
|
### Output
|
|
- `SendActivity` - Send text/attachments to user
|
|
- `EmitEvent` - Emit custom events
|
|
|
|
### Agent Invocation
|
|
- `InvokeAzureAgent` - Call an Azure AI agent
|
|
- `InvokePromptAgent` - Call a local prompt agent
|
|
|
|
### Human-in-Loop
|
|
- `Question` - Request user input
|
|
- `WaitForInput` - Pause for external input
|