db620d33df
CodeQL / Analyze (csharp) (push) Waiting to run
CodeQL / Analyze (python) (push) Waiting to run
dotnet-build-and-test / dotnet-test-functions (push) Has been cancelled
dotnet-build-and-test / paths-filter (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Debug, windows-latest, net9.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Release, ubuntu-latest, net10.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Release, ubuntu-latest, net8.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Release, windows-latest, net472) (push) Has been cancelled
dotnet-build-and-test / dotnet-test (Release, integration, true, ubuntu-latest, net10.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-test (Release, integration, true, windows-latest, net472) (push) Has been cancelled
dotnet-build-and-test / dotnet-foundry-hosted-it (push) Has been cancelled
dotnet-build-and-test / dotnet-build-and-test-check (push) Has been cancelled
dotnet-build-and-test / Integration Test Report (push) Has been cancelled
41 lines
1.6 KiB
Markdown
41 lines
1.6 KiB
Markdown
# Declarative Package (agent-framework-declarative)
|
|
|
|
YAML/JSON-based declarative agent and workflow definitions.
|
|
|
|
## Main Classes
|
|
|
|
- **`AgentFactory`** - Creates agents from declarative definitions
|
|
- **`WorkflowFactory`** - Creates workflows from declarative definitions
|
|
- **`WorkflowState`** - State management for declarative workflows
|
|
- **`ProviderTypeMapping`** - Maps provider types to implementations
|
|
- **`HttpRequestHandler`** / **`DefaultHttpRequestHandler`** - Pluggable HTTP transport for the `HttpRequestAction` declarative action (configured via `WorkflowFactory(http_request_handler=...)`)
|
|
- **`MCPToolHandler`** / **`DefaultMCPToolHandler`** - Pluggable MCP transport for the `InvokeMcpTool` declarative action (configured via `WorkflowFactory(mcp_tool_handler=...)`)
|
|
- **`DeclarativeLoaderError`** / **`ProviderLookupError`** / **`DeclarativeWorkflowError`** / **`DeclarativeActionError`** - Error types
|
|
|
|
## External Input Handling
|
|
|
|
- **`ExternalInputRequest`** / **`ExternalInputResponse`** - Human-in-the-loop support
|
|
- **`AgentExternalInputRequest`** / **`AgentExternalInputResponse`** - Agent-level input requests
|
|
|
|
## Usage
|
|
|
|
```python
|
|
from agent_framework.declarative import AgentFactory, WorkflowFactory
|
|
|
|
# Create agent from YAML file
|
|
agent_factory = AgentFactory()
|
|
agent = agent_factory.create_agent_from_yaml_path("agent.yaml")
|
|
|
|
# Create workflow from YAML file
|
|
workflow_factory = WorkflowFactory()
|
|
workflow = workflow_factory.create_workflow_from_yaml_path("workflow.yaml")
|
|
```
|
|
|
|
## Import Path
|
|
|
|
```python
|
|
from agent_framework.declarative import AgentFactory, WorkflowFactory
|
|
# or directly:
|
|
from agent_framework_declarative import AgentFactory
|
|
```
|