mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Evan Mattson
d8b9409e96
* fix Workflow.as_agent() streaming regression in ag-ui * Address PR feedback * workflows wip * wip * wip * Workflow AG-UI demo * Fixes for handoff workflow demo * Fixes to workflows support in AG-UI * Fixes * Add headers to some demo files * Fix comment * Fixes for store * Make _input_schema lazy-loaded * fix mypy * revert session change to handoff only for now --------- Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>
46 lines
1.8 KiB
Markdown
46 lines
1.8 KiB
Markdown
# AG-UI Package (agent-framework-ag-ui)
|
|
|
|
AG-UI protocol integration for building agent UIs with the AG-UI standard.
|
|
|
|
## Main Classes
|
|
|
|
- **`AgentFrameworkAgent`** - Wraps agents for AG-UI compatibility
|
|
- **`AgentFrameworkWorkflow`** - Wraps native `Workflow` objects, or accepts `workflow_factory(thread_id)` for thread-scoped workflow instances without subclassing
|
|
- **`AGUIChatClient`** - Chat client that speaks AG-UI protocol
|
|
- **`AGUIHttpService`** - HTTP service for AG-UI endpoints
|
|
- **`AGUIEventConverter`** - Converts between Agent Framework and AG-UI events
|
|
- **`add_agent_framework_fastapi_endpoint()`** - Add AG-UI endpoint to FastAPI app (`SupportsAgentRun` or `Workflow`)
|
|
|
|
## Types
|
|
|
|
- **`AGUIRequest`** / **`AGUIChatOptions`** - Request types
|
|
- **`availableInterrupts` / `resume`** - Optional interrupt configuration and continuation payloads
|
|
- **`AgentState`** / **`RunMetadata`** - State management types
|
|
- **`PredictStateConfig`** - Configuration for state prediction
|
|
|
|
## Protocol Notes
|
|
|
|
- Outbound custom events are emitted as AG-UI `CUSTOM`.
|
|
- Usage metadata from `Content(type="usage")` is surfaced as `CUSTOM` events with `name="usage"`.
|
|
- Inbound custom event aliases are accepted: `CUSTOM`, `CUSTOM_EVENT`, and `custom_event`.
|
|
- Multimodal user inputs support both legacy (`text`, `binary`) and draft-style (`image`, `audio`, `video`, `document`) shapes.
|
|
- `RUN_FINISHED.interrupt` can be emitted for pause/request-info flows, and interruption metadata is preserved in converters.
|
|
|
|
## Usage
|
|
|
|
```python
|
|
from agent_framework.ag_ui import add_agent_framework_fastapi_endpoint
|
|
from fastapi import FastAPI
|
|
|
|
app = FastAPI()
|
|
add_agent_framework_fastapi_endpoint(app, agent)
|
|
```
|
|
|
|
## Import Path
|
|
|
|
```python
|
|
from agent_framework.ag_ui import AGUIChatClient, add_agent_framework_fastapi_endpoint
|
|
# or directly:
|
|
from agent_framework_ag_ui import AGUIChatClient
|
|
```
|