mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Eduard van Valkenburg
0521f5bed8
* [BREAKING] Rename ChatAgent -> Agent, ChatMessage -> Message, ChatClientProtocol -> SupportsChatGetResponse Simplify the public API by removing redundant 'Chat' prefix from core types: - ChatAgent -> Agent - RawChatAgent -> RawAgent - ChatMessage -> Message - ChatClientProtocol -> SupportsChatGetResponse Also renamed internal WorkflowMessage (was Message in _runner_context) to avoid collision. No backward compatibility aliases - this is a clean breaking change. * [BREAKING] Rename Agent chat_client parameter to client * Fix rebase issues: WorkflowMessage references and broken markdown links * Fix formatting and lint issues from code quality checks * Fix import ordering in workflow sample files * fixed rebase * Fix test failures: use WorkflowMessage and A2AMessage after ChatMessage→Message rename - Replace Message(data=..., source_id=...) with WorkflowMessage(...) in workflow tests - Fix isinstance check in A2A agent to use A2AMessage instead of Message - Fix import in test_workflow_observability.py (Message→WorkflowMessage) * Fix lint, fmt, and sample errors after ChatMessage→Message rename - Auto-fix 70+ ruff lint issues across samples (ChatMessage→Message refs) - Fix HostedVectorStoreContent→Content.from_hosted_vector_store in file search sample - Fix _normalize_messages→normalize_messages in custom agent sample - Fix context.terminate→raise MiddlewareTermination in middleware samples - Fix with_update_hook→with_transform_hook in override middleware sample - Add TOptions_co import back to custom_chat_client sample - Add noqa for FastAPI File() default in chatkit sample - Fix B023 loop variable capture in weather agent sample * fix: update Agent constructor calls from chat_client to client in declaration-only tool tests * fix: add register_cleanup to devui lazy-loading proxy and type stub * fixed tests and updated new pieces * fix agui typevar * fix merge errors * fix merge conflicts * fiux merge * Remove unused links --------- Co-authored-by: Evan Mattson <evan.mattson@microsoft.com>
44 lines
1000 B
Markdown
44 lines
1000 B
Markdown
# DevUI Package (agent-framework-devui)
|
|
|
|
Interactive developer UI for testing and debugging agents and workflows.
|
|
|
|
## Main Classes
|
|
|
|
- **`serve()`** - Launch the DevUI server
|
|
- **`DevServer`** - The FastAPI-based development server
|
|
- **`register_cleanup()`** - Register cleanup hooks for entities
|
|
- **`CheckpointConversationManager`** - Manages conversation checkpoints
|
|
|
|
## Models
|
|
|
|
- **`AgentFrameworkRequest`** - Request model for agent invocations
|
|
- **`OpenAIResponse`** / **`OpenAIError`** - OpenAI-compatible response models
|
|
- **`DiscoveryResponse`** / **`EntityInfo`** - Entity discovery models
|
|
|
|
## Usage
|
|
|
|
```python
|
|
from agent_framework.devui import serve
|
|
|
|
agent = Agent(...)
|
|
serve(entities=[agent], port=8080, auto_open=True)
|
|
```
|
|
|
|
## CLI
|
|
|
|
```bash
|
|
# Run with auto-discovery
|
|
devui ./agents
|
|
|
|
# Run with specific entities
|
|
devui --entities my_agent.py
|
|
```
|
|
|
|
## Import Path
|
|
|
|
```python
|
|
from agent_framework.devui import serve, register_cleanup
|
|
# or directly:
|
|
from agent_framework_devui import serve
|
|
```
|