mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Eduard van Valkenburg
5ee06853a1
* [BREAKING] Redesign Python exception hierarchy Replace the flat ServiceException family with domain-scoped branches: - AgentException (with InvalidAuth, InvalidRequest, InvalidResponse, ContentFilter) - ChatClientException (same consistent suberrors) - IntegrationException (same + InitializationError) - WorkflowException (Runner, Convergence, Checkpoint, Validation, Action, Declarative) - ContentError (AdditionItemMismatch) - ToolException / ToolExecutionException (unchanged) - MiddlewareException / MiddlewareTermination (unchanged) Key changes: - All Service* exceptions removed (ServiceException, ServiceInitializationError, etc.) - AgentExecutionException split into AgentInvalidRequest/ResponseException - AgentInvocationError removed, split into AgentInvalidRequest/ResponseException - Workflow exceptions moved from _workflows/_exceptions.py into main exceptions.py - _workflows/__init__.py emptied; main __init__.py imports directly from submodules - Purview exceptions re-parented under IntegrationException hierarchy - Init validation errors use built-in ValueError/TypeError instead of custom exceptions - CODING_STANDARD.md updated with hierarchy design and rationale Fixes microsoft/agent-framework#3410 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Clarify ToolException vs ToolExecutionException docstrings ToolException: base class for all tool-related exceptions (preconditions, connection/init failures). ToolExecutionException: runtime call failures (tool call failed, reconnect failed, MCP errors). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix remaining stale imports from agent_framework._workflows - azurefunctions: _context.py, _app.py, _serialization.py, test_func_utils.py used 'from agent_framework._workflows import X' which broke after emptying _workflows/__init__.py; changed to direct submodule imports - azure-ai-search: test still referenced ServiceInitializationError; updated to ValueError to match production code Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
45 lines
1.4 KiB
Markdown
45 lines
1.4 KiB
Markdown
# Purview Package (agent-framework-purview)
|
|
|
|
Integration with Microsoft Purview for data governance and policy enforcement.
|
|
|
|
## Main Classes
|
|
|
|
### Middleware
|
|
|
|
- **`PurviewPolicyMiddleware`** - Agent middleware for Purview policy enforcement
|
|
- **`PurviewChatPolicyMiddleware`** - Chat-level middleware for policy enforcement
|
|
|
|
### Configuration
|
|
|
|
- **`PurviewSettings`** - Pydantic settings for Purview configuration
|
|
- **`PurviewAppLocation`** / **`PurviewLocationType`** - Location configuration
|
|
|
|
### Caching
|
|
|
|
- **`CacheProvider`** - Cache provider for Purview policy caching
|
|
|
|
### Exceptions
|
|
|
|
- **`PurviewAuthenticationError`** - Authentication failures (inherits from `IntegrationInvalidAuthException`)
|
|
- **`PurviewRateLimitError`** - Rate limit exceeded (inherits from `IntegrationException` via `PurviewServiceError`)
|
|
- **`PurviewRequestError`** / **`PurviewServiceError`** - Request/service errors (inherit from `IntegrationException`)
|
|
- **`PurviewPaymentRequiredError`** - Payment required (inherits from `IntegrationException` via `PurviewServiceError`)
|
|
|
|
## Usage
|
|
|
|
```python
|
|
from agent_framework.microsoft import PurviewPolicyMiddleware, PurviewSettings
|
|
|
|
settings = PurviewSettings(...)
|
|
middleware = PurviewPolicyMiddleware(settings=settings)
|
|
agent = Agent(..., middleware=[middleware])
|
|
```
|
|
|
|
## Import Path
|
|
|
|
```python
|
|
from agent_framework.microsoft import PurviewPolicyMiddleware
|
|
# or directly:
|
|
from agent_framework_purview import PurviewPolicyMiddleware
|
|
```
|