mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Jose Luis Latorre Millas
f415959d33
* Adding Sample for writer-critic workflow implemented using Worfklow, custom executors, agents, switch, custom states, different entry points for the executors. * Update dotnet/samples/GettingStarted/Workflows/_Foundational/08_WriterCriticWorkflow/Program.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update dotnet/samples/GettingStarted/Workflows/_Foundational/08_WriterCriticWorkflow/Program.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * using now structured output, with streaming for UX responsiveness. * improved comments and order, so comments directly precede what they're describing * fixing issue with internal class that the analyzer doesn't recognize that CriticDecision is instantiated, just indirectly via JSON deserialization --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Chris <66376200+crickman@users.noreply.github.com>
83 lines
4.2 KiB
Markdown
83 lines
4.2 KiB
Markdown
# Workflow Getting Started Samples
|
|
|
|
The getting started with workflow samples demonstrate the fundamental concepts and functionalities of workflows in Agent Framework.
|
|
|
|
## Samples Overview
|
|
|
|
### Foundational Concepts - Start Here
|
|
|
|
Please begin with the [Foundational](./_Foundational) samples in order. These three samples introduce the core concepts of executors, edges, agents in workflows, streaming, and workflow construction.
|
|
|
|
> The folder name starts with an underscore (`_Foundational`) to ensure it appears first in the explorer view.
|
|
|
|
| Sample | Concepts |
|
|
|--------|----------|
|
|
| [Executors and Edges](./_Foundational/01_ExecutorsAndEdges) | Minimal workflow with basic executors and edges |
|
|
| [Streaming](./_Foundational/02_Streaming) | Extends workflows with event streaming |
|
|
| [Agents](./_Foundational/03_AgentsInWorkflows) | Use agents in workflows |
|
|
| [Agentic Workflow Patterns](./_Foundational/04_AgentWorkflowPatterns) | Demonstrates common agentic workflow patterns |
|
|
| [Multi-Service Workflows](./_Foundational/05_MultiModelService) | Shows using multiple AI services in the same workflow |
|
|
| [Sub-Workflows](./_Foundational/06_SubWorkflows) | Demonstrates composing workflows hierarchically by embedding workflows as executors |
|
|
| [Mixed Workflow with Agents and Executors](./_Foundational/07_MixedWorkflowAgentsAndExecutors) | Shows how to mix agents and executors with adapter pattern for type conversion and protocol handling |
|
|
| [Writer-Critic Workflow](./_Foundational/08_WriterCriticWorkflow) | Demonstrates iterative refinement with quality gates, max iteration safety, multiple message handlers, and conditional routing for feedback loops |
|
|
|
|
Once completed, please proceed to other samples listed below.
|
|
|
|
> Note that you don't need to follow a strict order after the foundational samples. However, some samples build upon concepts from previous ones, so it's beneficial to be aware of the dependencies.
|
|
|
|
### Agents
|
|
|
|
| Sample | Concepts |
|
|
|--------|----------|
|
|
| [Foundry Agents in Workflows](./Agents/FoundryAgent) | Demonstrates using Azure Foundry Agents within a workflow |
|
|
| [Custom Agent Executors](./Agents/CustomAgentExecutors) | Shows how to create a custom agent executor for more complex scenarios |
|
|
| [Workflow as an Agent](./Agents/WorkflowAsAnAgent) | Illustrates how to encapsulate a workflow as an agent |
|
|
|
|
### Concurrent Execution
|
|
|
|
| Sample | Concepts |
|
|
|--------|----------|
|
|
| [Fan-Out and Fan-In](./Concurrent) | Introduces parallel processing with fan-out and fan-in patterns |
|
|
|
|
### Loop
|
|
|
|
| Sample | Concepts |
|
|
|--------|----------|
|
|
| [Looping](./Loop) | Shows how to create a loop within a workflow |
|
|
|
|
### Workflow Shared States
|
|
|
|
| Sample | Concepts |
|
|
|--------|----------|
|
|
| [Shared States](./SharedStates) | Demonstrates shared states between executors for data sharing and coordination |
|
|
|
|
### Conditional Edges
|
|
|
|
| Sample | Concepts |
|
|
|--------|----------|
|
|
| [Edge Conditions](./ConditionalEdges/01_EdgeCondition) | Introduces conditional edges for dynamic routing based on executor outputs |
|
|
| [Switch-Case Routing](./ConditionalEdges/02_SwitchCase) | Extends conditional edges with switch-case routing for multiple paths |
|
|
| [Multi-Selection Routing](./ConditionalEdges/03_MultiSelection) | Demonstrates multi-selection routing where one executor can trigger multiple downstream executors |
|
|
|
|
> These 3 samples build upon each other. It's recommended to explore them in sequence to fully grasp the concepts.
|
|
|
|
### Declarative Workflows
|
|
|
|
| Sample | Concepts |
|
|
|--------|----------|
|
|
| [Declarative](./Declarative) | Demonstrates execution of declartive workflows. |
|
|
|
|
### Checkpointing
|
|
|
|
| Sample | Concepts |
|
|
|--------|----------|
|
|
| [Checkpoint and Resume](./Checkpoint/CheckpointAndResume) | Introduces checkpoints for saving and restoring workflow state for time travel purposes |
|
|
| [Checkpoint and Rehydrate](./Checkpoint/CheckpointAndRehydrate) | Demonstrates hydrating a new workflow instance from a saved checkpoint |
|
|
| [Checkpoint with Human-in-the-Loop](./Checkpoint/CheckpointWithHumanInTheLoop) | Combines checkpointing with human-in-the-loop interactions |
|
|
|
|
### Human-in-the-Loop
|
|
|
|
| Sample | Concepts |
|
|
|--------|----------|
|
|
| [Basic Human-in-the-Loop](./HumanInTheLoop/HumanInTheLoopBasic) | Introduces human-in-the-loop interaction using input ports and external requests |
|