agent/agent-framework
1
0
Fork 0
mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
5e056b672e8a9035f917c4e2391b84f03efddf78
agent-framework/python/samples/demos/ag_ui_workflow_handoff
T
Eduard van Valkenburg 5e056b672e Python: [BREAKING] Python: Provider-leading client design & OpenAI package extraction (#4818) 
* Python: Provider-leading client design & OpenAI package extraction

Major refactoring of the Python Agent Framework client architecture:

- Extract OpenAI clients into new `agent-framework-openai` package
- Core package no longer depends on openai, azure-identity, azure-ai-projects
- Rename clients for discoverability: OpenAIResponsesClient → OpenAIChatClient,
  OpenAIChatClient → OpenAIChatCompletionClient
- Unify `model_id`/`deployment_name`/`model_deployment_name` → `model` param
- New FoundryChatClient for Azure AI Foundry Responses API
- New FoundryAgent/FoundryAgentClient for connecting to pre-configured Foundry agents
- Remove OpenAIBase/OpenAIConfigMixin from non-deprecated client MRO
- Deprecate AzureOpenAI* clients, AzureAIClient, OpenAIAssistantsClient
- Reorganize samples: azure_openai+azure_ai+azure_ai_agent → azure/
- ADR-0020: Provider-Leading Client Design

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: missing Agent imports in samples, .model_id → .model in foundry_local sample

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: CI failures — mypy errors, coverage targets, sample imports

- azure-ai mypy: add type ignores for TypedDict total=, model arg, forward ref
- Coverage: replace core.azure/openai targets with openai package target
- project_provider: add type annotation for opts dict

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: populate openai .pyi stub, fix broken README links, coverage targets

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fixes

* updated observabilitty

* reset azure init.pyi

* fix errors

* updated adr number

* fix foundry local

* fixed not renamed docstrings and comments, and added deprecated markers to old classes

* fix tests and pyprojects

* fix test vars

* updated function tests

* update durable

* updated test setup for functions

* Fix Foundry auth in workflow samples

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Stabilize Python integration workflows

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Update hosting samples for Foundry

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Trigger full CI rerun

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Trigger CI rerun again

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* trigger rerun

* trigger rerun

* fix for litellm

* undo durabletask changes

* Move Foundry APIs into foundry namespace

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix Foundry pyproject formatting

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Split provider samples by Foundry surface

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Restore hosting sample requirements

Also fix the Foundry Local sample link after the provider sample move.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* updated tests

* udpated foundry integration tests

* removed dist from azurefunctions tests

* Use separate Foundry clients for concurrent agents

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix client setup in azfunc and durable

* disabled two tests

* updated setup for some function and durable tests

* improved azure openai setup with new clients

* ignore deprecated

* fixes

* skip 11

* remove openai assistants int tests

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
5e056b672e · 2026-03-25 09:56:29 +00:00
History
..
backend
Python: [BREAKING] Python: Provider-leading client design & OpenAI package extraction (#4818)
2026-03-25 09:56:29 +00:00
frontend
Bump rollup in /python/samples/demos/ag_ui_workflow_handoff/frontend (#4284)
2026-03-02 23:06:34 +00:00
README.md
Python: (ag-ui): Add Workflow Support, Harden Streaming Semantics, and add Dynamic Handoff Demo (#3911)
2026-02-23 11:59:56 +00:00

README.md

AG-UI Handoff Workflow Demo

This demo is a full custom AG-UI application built on top of the new workflow abstractions in agent_framework_ag_ui.

It includes:

  • A backend FastAPI AG-UI endpoint serving a HandoffBuilder workflow with:
    • triage_agent
    • refund_agent
    • order_agent
  • Required tool approval checkpoints:
    • submit_refund (approval_mode="always_require")
    • submit_replacement (approval_mode="always_require")
  • A second request-info resume step (order agent asks for shipping preference)
  • A frontend React app that consumes AG-UI SSE events, renders workflow cards, and sends resume.interrupts payloads.

The backend uses Azure OpenAI responses and supports intent-driven, non-linear handoff routing.

Folder Layout

  • backend/server.py - FastAPI + AG-UI endpoint + Handoff workflow
  • frontend/ - Vite + React AG-UI client UI

Prerequisites

  • Python 3.10+
  • Node.js 18+
  • npm 9+
  • Azure AI project + model deployment configured in environment variables:
    • AZURE_AI_PROJECT_ENDPOINT
    • AZURE_AI_MODEL_DEPLOYMENT_NAME

1) Run Backend

From the Python repo root:

cd /Users/evmattso/git/agent-framework/python
uv sync
uv run python samples/demos/ag_ui_workflow_handoff/backend/server.py

Backend default URL:

  • http://127.0.0.1:8891
  • AG-UI endpoint: POST http://127.0.0.1:8891/handoff_demo

2) Install Frontend Packages (npm)

cd /Users/evmattso/git/agent-framework/python/samples/demos/ag_ui_workflow_handoff/frontend
npm install

3) Run Frontend Locally

npm run dev

Frontend default URL:

  • http://127.0.0.1:5173

If you changed backend host/port, run with:

VITE_BACKEND_URL=http://127.0.0.1:8891 npm run dev

4) Demo Flow to Verify

  1. Click one of the starter prompts (or type a refund request).
  2. Refund Agent asks for an order number; reply with a numeric ID (for example: 987654).
  3. If your initial request did not explicitly choose refund vs replacement, the agent asks a clarifying choice question.
  4. Wait for the submit_refund reviewer interrupt (built from your provided order ID).
  5. In the HITL Reviewer Console modal, click Approve Tool Call.
  6. If you asked for replacement, the Order agent asks for shipping preference; reply in the chat input (for example: expedited).
  7. When replacement is requested, wait for the submit_replacement reviewer interrupt and approve/reject it.
  8. If you asked for refund-only, the flow should close without replacement/shipping prompts.
  9. Confirm the case snapshot updates and workflow completion.

What This Validates

  • add_agent_framework_fastapi_endpoint(...) with AgentFrameworkWorkflow(workflow_factory=...)
  • Thread-scoped workflow state across turns
  • RUN_FINISHED.interrupt pause behavior
  • resume.interrupts continuation behavior
  • JSON resume payload coercion for Content and list[Message] workflow response types
  • Intent-driven routing between triage, refund, and order specialists (no forced linear path)
  • Multiple HITL approvals in one case (submit_refund + submit_replacement)
Reference in New Issue View Git Blame Copy Permalink