Skip to content

Commit 97629c9

Browse files
authored
Merge pull request #299 from microsoft/james-dev
add documentation
2 parents 3211477 + c1ef170 commit 97629c9

File tree

4 files changed

+103
-1
lines changed

4 files changed

+103
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,44 @@ Welcome to the official repository for the Microsoft AI Agentic Workshop! This r
6868
2. Explore the [Business Scenario and Agent Design](./SCENARIO.md) to understand the workshop challenge.
6969
3. Check out the **[Agent Framework Implementation Patterns](agentic_ai/agents/agent_framework/README.md)** to choose the right multi-agent approach (single-agent, Magentic orchestration, or handoff pattern).
7070
4. Dive into [System Architecture](./ARCHITECTURE.md) before building and customizing your agent solutions.
71-
5. Utilize the [Support Guide](./SUPPORT.md) for troubleshooting and assistance.
71+
5. Explore **[Workflow Examples & Production Demos](agentic_ai/workflow/)** to learn advanced orchestration patterns.
72+
6. Utilize the [Support Guide](./SUPPORT.md) for troubleshooting and assistance.
73+
74+
---
75+
76+
## Workflow Orchestration
77+
78+
The workshop includes comprehensive **workflow orchestration** capabilities built on the Microsoft Agent Framework's Pregel-style execution engine. Workflows enable complex multi-agent coordination with type-safe messaging, checkpointing, and real-time observability.
79+
80+
### 🎯 Featured Demo: Fraud Detection System
81+
82+
A production-ready fraud detection workflow showcasing enterprise-grade patterns:
83+
84+
- **Real-time React dashboard** with live workflow visualization
85+
- **Fan-out/fan-in patterns** for parallel specialist agent analysis
86+
- **Human-in-the-loop** analyst review with checkpointing
87+
- **MCP tool integration** for customer data access
88+
- **WebSocket streaming** for live event updates
89+
90+
**[→ Try the Fraud Detection Demo](agentic_ai/workflow/fraud_detection/)**
91+
92+
### 📚 Learning Resources
93+
94+
| Resource | Description |
95+
|----------|-------------|
96+
| **[Workflow Architecture Guide](agentic_ai/workflow/README.md)** | Core concepts, execution model, and API reference |
97+
| **[Human-in-the-Loop Patterns](agentic_ai/workflow/human-in-the-loop.md)** | Comprehensive guide to approval workflows |
98+
| **[Fraud Detection Demo](agentic_ai/workflow/fraud_detection/)** | Production-ready workflow with real-time UI |
99+
100+
### Key Capabilities
101+
102+
**Control Flow**: Switch/case routing, conditional edges, dynamic branching
103+
**Parallelism**: Fan-out/fan-in, concurrent execution, aggregation patterns
104+
**Checkpointing**: Pause/resume workflows, long-running processes, crash recovery
105+
**Human-in-the-Loop**: External approvals, RequestInfoExecutor, response handling
106+
**State Management**: Executor-local state, shared state, persistence
107+
**Observability**: OpenTelemetry tracing, event streaming, real-time monitoring
108+
**Composition**: Nested workflows, workflow-as-agent, modular design
72109

73110
---
74111

agentic_ai/workflow/ARCHITECTURE.md renamed to agentic_ai/workflow/README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,3 +145,51 @@ workflow.run() returns WorkflowRunResult([WorkflowOutputEvent("DLROW OLLEH"), ..
145145
- Magentic multi-agent orchestration: `_magentic.py`.
146146

147147
This architecture balances **expressiveness** (flexible routing, composition), **type safety** (runtime contract enforcement), **observability** (OpenTelemetry spans, event streams), and **durability** (checkpointing for long-running workflows), making it suitable for both simple pipelines and complex multi-agent systems.
148+
149+
---
150+
151+
## Demo: Fraud Detection Workflow
152+
153+
### 🎯 Production-Ready Implementation
154+
155+
A comprehensive fraud detection system showcasing enterprise workflow patterns:
156+
157+
| Feature | Description |
158+
|---------|-------------|
159+
| **Architecture** | Fan-out/fan-in pattern with parallel specialist agents |
160+
| **Human-in-the-Loop** | Analyst review for high-risk cases with checkpointing |
161+
| **Real-Time UI** | React + FastAPI dashboard with WebSocket streaming |
162+
| **MCP Integration** | Filtered tool access for domain-specific analysis |
163+
| **Persistence** | Checkpoint storage for pause/resume workflows |
164+
165+
**[→ Explore the Fraud Detection Demo](fraud_detection/)**
166+
167+
---
168+
169+
## Quick Start
170+
171+
**Try the Fraud Detection Demo:**
172+
173+
```bash
174+
# Terminal 1: Start MCP Server
175+
cd mcp
176+
uv run mcp_service.py
177+
178+
# Terminal 2: Start Backend
179+
cd agentic_ai/workflow/fraud_detection
180+
uv run --prerelease allow backend.py
181+
182+
# Terminal 3: Start Frontend
183+
cd agentic_ai/workflow/fraud_detection/ui
184+
npm install && npm run dev
185+
186+
# Open browser: http://localhost:3000
187+
```
188+
189+
---
190+
191+
## Additional Resources
192+
193+
- **[Human-in-the-Loop Guide](human-in-the-loop.md)** - Comprehensive HITL patterns
194+
- **[Agent Framework GitHub](https://github.com/microsoft/agent-framework)** - Official framework repository
195+
- **[API Documentation](https://github.com/microsoft/agent-framework/tree/main/docs)** - Detailed API reference

agentic_ai/workflow/fraud_detection/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,16 @@ instructions=(
267267
8. **Type-Safe Messaging**: Pydantic models for all messages
268268
9. **Event Streaming**: Real-time workflow event monitoring
269269

270+
## Recent Improvements
271+
272+
### ✅ Fixed Issues (Latest)
273+
274+
1. **Analyst Review Data Rendering**: Fixed dataclass serialization in `_serialize_analyst_request()` to properly display Risk Score, Recommended Action, Alert ID, and other assessment details in the UI.
275+
276+
2. **Event Ordering**: Corrected event broadcast sequence so Analyst Review completion appears before Fraud Action execution, maintaining proper workflow visualization order.
277+
278+
These fixes ensure the UI accurately reflects the workflow state and displays all relevant fraud assessment information during analyst review.
279+
270280
## Troubleshooting
271281

272282
### MCP Connection Fails
@@ -285,6 +295,13 @@ echo $AZURE_OPENAI_CHAT_DEPLOYMENT
285295
echo $AZURE_OPENAI_ENDPOINT
286296
```
287297

298+
### Analyst Review Panel Not Showing Data
299+
300+
This should now be fixed. If you still see issues:
301+
- Restart the backend server to load the updated code
302+
- Check browser console for WebSocket errors
303+
- Verify the MCP server is responding
304+
288305
### Workflow Hangs
289306

290307
Check logs for executor errors. Each executor logs its progress.
File renamed without changes.

0 commit comments

Comments
 (0)