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

Files

T

claude89757 3e13909e59 Python: Add Pydantic request model and OpenAPI tags support to AG-UI FastAPI endpoint (#2522 )

* feat(ag-ui): Add Pydantic request model and OpenAPI tags support

- Add AGUIRequest Pydantic model in _types.py with field descriptions
- Update add_agent_framework_fastapi_endpoint() to accept tags parameter
- Use AGUIRequest model for automatic validation and OpenAPI schema generation
- Export AGUIRequest and DEFAULT_TAGS in __init__.py
- Update test_endpoint.py to expect 422 for invalid requests
- Add tests for OpenAPI schema, default tags, custom tags, and validation

Benefits:
- Better API documentation with complete request schema in Swagger UI
- Automatic request validation with Pydantic
- Organized endpoints under 'AG-UI' tag instead of 'default'
- Improved developer experience and type safety

Fixes #<issue-number>

* test(ag-ui): Add test for internal error handling to achieve 100% coverage

- Add test_endpoint_internal_error_handling() to cover exception handling code
- Mock copy.deepcopy to simulate internal error during default_state processing
- Add type: ignore for FastAPI tags parameter (known pyright compatibility issue)
- Achieves 100% test coverage for _endpoint.py (previously missing lines 103-105)

3e13909e59 · 2026-01-12 15:07:34 +00:00

History

agent_framework_ag_ui

Python: Add Pydantic request model and OpenAPI tags support to AG-UI FastAPI endpoint (#2522 )

2026-01-12 15:07:34 +00:00

agent_framework_ag_ui_examples

Python: fix(ag-ui): Execute tools with approval_mode, fix shared state, code cleanup (#3079 )

2026-01-09 03:08:05 +00:00

getting_started

Python: Clean up imports (#2318 )

2025-11-19 23:41:01 +00:00

tests

Python: Add Pydantic request model and OpenAPI tags support to AG-UI FastAPI endpoint (#2522 )

2026-01-12 15:07:34 +00:00

LICENSE

Python: AG-UI protocol support (#1826 )

2025-11-05 05:25:24 +00:00

pyproject.toml

Python: Bump python version to 1.0.0b260107 for a release (#3128 )

2026-01-08 08:49:28 +09:00

README.md

Python: Clean up imports (#2318 )

2025-11-19 23:41:01 +00:00

README.md

Agent Framework AG-UI Integration

AG-UI protocol integration for Agent Framework, enabling seamless integration with AG-UI's web interface and streaming protocol.

Installation

pip install agent-framework-ag-ui

Quick Start

Server (Host an AI Agent)

from fastapi import FastAPI
from agent_framework import ChatAgent
from agent_framework.azure import AzureOpenAIChatClient
from agent_framework.ag_ui import add_agent_framework_fastapi_endpoint

# Create your agent
agent = ChatAgent(
    name="my_agent",
    instructions="You are a helpful assistant.",
    chat_client=AzureOpenAIChatClient(
        endpoint="https://your-resource.openai.azure.com/",
        deployment_name="gpt-4o-mini",
        api_key="your-api-key",
    ),
)

# Create FastAPI app and add AG-UI endpoint
app = FastAPI()
add_agent_framework_fastapi_endpoint(app, agent, "/")

# Run with: uvicorn main:app --reload

Client (Connect to an AG-UI Server)

import asyncio
from agent_framework import TextContent
from agent_framework.ag_ui import AGUIChatClient

async def main():
    async with AGUIChatClient(endpoint="http://localhost:8000/") as client:
        # Stream responses
        async for update in client.get_streaming_response("Hello!"):
            for content in update.contents:
                if isinstance(content, TextContent):
                    print(content.text, end="", flush=True)
        print()

asyncio.run(main())

The AGUIChatClient supports:

Streaming and non-streaming responses
Hybrid tool execution (client-side + server-side tools)
Automatic thread management for conversation continuity
Integration with ChatAgent for client-side history management

Documentation

Getting Started Tutorial - Step-by-step guide to building AG-UI servers and clients
- Server setup with FastAPI
- Client examples using AGUIChatClient
- Hybrid tool execution (client-side + server-side)
- Thread management and conversation continuity
Examples - Complete examples for AG-UI features

Features

This integration supports all 7 AG-UI features:

Agentic Chat: Basic streaming chat with tool calling support
Backend Tool Rendering: Tools executed on backend with results streamed to client
Human in the Loop: Function approval requests for user confirmation before tool execution
Agentic Generative UI: Async tools for long-running operations with progress updates
Tool-based Generative UI: Custom UI components rendered on frontend based on tool calls
Shared State: Bidirectional state sync between client and server
Predictive State Updates: Stream tool arguments as optimistic state updates during execution

Architecture

The package uses a clean, orchestrator-based architecture:

AgentFrameworkAgent: Lightweight wrapper that delegates to orchestrators
Orchestrators: Handle different execution flows (default, human-in-the-loop, etc.)
Confirmation Strategies: Domain-specific confirmation messages (extensible)
AgentFrameworkEventBridge: Converts Agent Framework events to AG-UI events
Message Adapters: Bidirectional conversion between AG-UI and Agent Framework message formats
FastAPI Endpoint: Streaming HTTP endpoint with Server-Sent Events (SSE)

Next Steps

New to AG-UI? Start with the Getting Started Tutorial
Want to see examples? Check out the Examples for AG-UI features

License

MIT