mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00

Files

T

Eduard van Valkenburg a2856d3b92 Python: restructure: Python samples into progressive 01-05 layout (#3862 )

* 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

a2856d3b92 · 2026-02-12 17:36:36 +00:00

History

main.py

Python: restructure: Python samples into progressive 01-05 layout (#3862 )

2026-02-12 17:36:36 +00:00

README.md

Python: restructure: Python samples into progressive 01-05 layout (#3862 )

2026-02-12 17:36:36 +00:00

workflow.yaml

Python: restructure: Python samples into progressive 01-05 layout (#3862 )

2026-02-12 17:36:36 +00:00

README.md

Human-in-Loop Workflow Sample

This sample demonstrates how to build interactive workflows that request user input during execution using the Question, RequestExternalInput, and WaitForInput actions.

What This Sample Shows

Using Question to prompt for user responses
Using RequestExternalInput to request external data
Using WaitForInput to pause and wait for input
Processing user responses to drive workflow decisions
Interactive conversation patterns

Files

workflow.yaml - The declarative workflow definition
main.py - Python script that loads and runs the workflow with simulated user interaction

Running the Sample

Ensure you have the package installed:

cd python
pip install -e packages/agent-framework-declarative

Run the sample:
```
python main.py
```

How It Works

The workflow demonstrates a simple survey/questionnaire pattern:

Greeting: Sends a welcome message
Question 1: Asks for the user's name
Question 2: Asks how they're feeling today
Processing: Stores responses and provides personalized feedback
Summary: Summarizes the collected information

The main.py script shows how to handle ExternalInputRequest to provide responses during workflow execution.

Key Concepts

ExternalInputRequest

When a human-in-loop action is executed, the workflow yields an ExternalInputRequest containing:

variable: The variable path where the response should be stored
prompt: The question or prompt text for the user

The workflow runner should:

Detect ExternalInputRequest in the event stream
Display the prompt to the user
Collect the response
Resume the workflow (in a real implementation, using external loop patterns)

ExternalLoopEvent

For more complex scenarios where external processing is needed, the workflow can yield an ExternalLoopEvent that signals the runner to pause and wait for external input.