mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
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
This commit is contained in:
committed by
GitHub
Unverified
parent
69dcfe31ee
commit
a2856d3b92
@@ -0,0 +1,124 @@
|
||||
# Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
import asyncio
|
||||
from typing import Any, cast
|
||||
|
||||
from agent_framework import (
|
||||
Executor,
|
||||
WorkflowBuilder,
|
||||
WorkflowContext,
|
||||
handler,
|
||||
)
|
||||
from typing_extensions import Never
|
||||
|
||||
"""
|
||||
Executor I/O Observation
|
||||
|
||||
This sample demonstrates how to observe executor input and output data without modifying
|
||||
executor code. This is useful for debugging, logging, or building monitoring tools.
|
||||
|
||||
What this example shows:
|
||||
- executor_invoked events (type='executor_invoked') contain the input message in event.data
|
||||
- executor_completed events (type='executor_completed') contain the messages sent via ctx.send_message() in event.data
|
||||
- How to generically observe all executor I/O through workflow streaming events
|
||||
|
||||
This approach allows you to enable_instrumentation any workflow for observability without
|
||||
changing the executor implementations.
|
||||
|
||||
Prerequisites:
|
||||
- No external services required.
|
||||
"""
|
||||
|
||||
|
||||
class UpperCaseExecutor(Executor):
|
||||
"""Convert input text to uppercase and forward to next executor."""
|
||||
|
||||
def __init__(self, id: str = "upper_case"):
|
||||
super().__init__(id=id)
|
||||
|
||||
@handler
|
||||
async def handle(self, text: str, ctx: WorkflowContext[str]) -> None:
|
||||
result = text.upper()
|
||||
await ctx.send_message(result)
|
||||
|
||||
|
||||
class ReverseTextExecutor(Executor):
|
||||
"""Reverse the input text and yield as workflow output."""
|
||||
|
||||
def __init__(self, id: str = "reverse_text"):
|
||||
super().__init__(id=id)
|
||||
|
||||
@handler
|
||||
async def handle(self, text: str, ctx: WorkflowContext[Never, str]) -> None:
|
||||
result = text[::-1]
|
||||
await ctx.yield_output(result)
|
||||
|
||||
|
||||
def format_io_data(data: Any) -> str:
|
||||
"""Format executor I/O data for display.
|
||||
|
||||
This helper formats common data types for readable output.
|
||||
Customize based on the types used in your workflow.
|
||||
"""
|
||||
type_name = type(data).__name__
|
||||
|
||||
if data is None:
|
||||
return "None"
|
||||
if isinstance(data, str):
|
||||
preview = data[:80] + "..." if len(data) > 80 else data
|
||||
return f"{type_name}: '{preview}'"
|
||||
if isinstance(data, list):
|
||||
data_list = cast(list[Any], data)
|
||||
if len(data_list) == 0:
|
||||
return f"{type_name}: []"
|
||||
# For sent_messages, show each item with its type
|
||||
if len(data_list) <= 3:
|
||||
items = [format_io_data(item) for item in data_list]
|
||||
return f"{type_name}: [{', '.join(items)}]"
|
||||
return f"{type_name}: [{len(data_list)} items]"
|
||||
return f"{type_name}: {repr(data)}"
|
||||
|
||||
|
||||
async def main() -> None:
|
||||
"""Build a workflow and observe executor I/O through streaming events."""
|
||||
upper_case = UpperCaseExecutor()
|
||||
reverse_text = ReverseTextExecutor()
|
||||
|
||||
workflow = WorkflowBuilder(start_executor=upper_case).add_edge(upper_case, reverse_text).build()
|
||||
|
||||
print("Running workflow with executor I/O observation...\n")
|
||||
|
||||
async for event in workflow.run("hello world", stream=True):
|
||||
if event.type == "executor_invoked":
|
||||
# The input message received by the executor is in event.data
|
||||
print(f"[INVOKED] {event.executor_id}")
|
||||
print(f" Input: {format_io_data(event.data)}")
|
||||
|
||||
elif event.type == "executor_completed":
|
||||
# Messages sent via ctx.send_message() are in event.data
|
||||
print(f"[COMPLETED] {event.executor_id}")
|
||||
if event.data:
|
||||
print(f" Output: {format_io_data(event.data)}")
|
||||
|
||||
elif event.type == "output":
|
||||
print(f"[WORKFLOW OUTPUT] {format_io_data(event.data)}")
|
||||
|
||||
"""
|
||||
Sample Output:
|
||||
|
||||
Running workflow with executor I/O observation...
|
||||
|
||||
[INVOKED] upper_case
|
||||
Input: str: 'hello world'
|
||||
[COMPLETED] upper_case
|
||||
Output: list: [str: 'HELLO WORLD']
|
||||
[INVOKED] reverse_text
|
||||
Input: str: 'HELLO WORLD'
|
||||
[WORKFLOW OUTPUT] str: 'DLROW OLLEH'
|
||||
[COMPLETED] reverse_text
|
||||
Output: list: [str: 'DLROW OLLEH']
|
||||
"""
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
asyncio.run(main())
|
||||
Reference in New Issue
Block a user