|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to the AgentGuard Python SDK will be documented in this file. |
| 4 | + |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [Unreleased] |
| 9 | + |
| 10 | +## [0.2.2] - 2026-01-31 |
| 11 | + |
| 12 | +### Added |
| 13 | +- **Cost Tracking & Budget Management** - Complete feature parity with TypeScript SDK v0.2.2 |
| 14 | + - `CostTracker` - Track AI model costs across OpenAI, Anthropic, and Azure OpenAI |
| 15 | + - `BudgetManager` - Create and enforce budgets with alerts and blocking |
| 16 | + - `InMemoryCostStorage` - Store and query cost records |
| 17 | + - Support for 20+ AI models with accurate pricing |
| 18 | + - Custom pricing support for proprietary models |
| 19 | + - Budget periods: hourly, daily, weekly, monthly, total |
| 20 | + - Alert thresholds with severity levels (info, warning, critical) |
| 21 | + - Agent-scoped budgets for multi-agent systems |
| 22 | + |
| 23 | +- **Guarded AI Clients** - Drop-in replacements with integrated security |
| 24 | + - `GuardedOpenAI` - Secure OpenAI client with guardrails and cost tracking |
| 25 | + - `GuardedAnthropic` - Secure Anthropic client with guardrails and cost tracking |
| 26 | + - `GuardedAzureOpenAI` - Secure Azure OpenAI client with deployment mapping |
| 27 | + - Automatic input/output guardrail execution |
| 28 | + - Pre-request budget checking and enforcement |
| 29 | + - Automatic cost calculation and recording |
| 30 | + - Security metadata in all responses |
| 31 | + |
| 32 | +- **Example Scripts** - Comprehensive demos for all new features |
| 33 | + - `cost_tracking_demo.py` - Cost estimation and tracking examples |
| 34 | + - `budget_management_demo.py` - Budget creation and enforcement examples |
| 35 | + - `guarded_openai_demo.py` - GuardedOpenAI usage examples |
| 36 | + - `guarded_anthropic_demo.py` - GuardedAnthropic usage examples |
| 37 | + - `guarded_azure_openai_demo.py` - GuardedAzureOpenAI usage examples |
| 38 | + |
| 39 | +### Features |
| 40 | +- **Multi-Provider Support**: OpenAI, Anthropic, Azure OpenAI |
| 41 | +- **Accurate Pricing**: Real-time cost calculation for 20+ models |
| 42 | +- **Budget Enforcement**: Block requests that exceed budgets |
| 43 | +- **Alert System**: Configurable thresholds with severity levels |
| 44 | +- **Agent Isolation**: Separate budgets per agent |
| 45 | +- **Cost Queries**: Query costs by agent, date range, request ID |
| 46 | +- **Custom Pricing**: Override pricing for custom models |
| 47 | +- **Deployment Mapping**: Azure deployment names to model names |
| 48 | +- **Security Integration**: Guardrails + cost tracking in one client |
| 49 | + |
| 50 | +### Performance |
| 51 | +- Async-first design for all operations |
| 52 | +- Efficient in-memory storage with O(1) lookups |
| 53 | +- Parallel guardrail execution |
| 54 | +- < 10ms cost calculation overhead |
| 55 | + |
| 56 | +### Documentation |
| 57 | +- Updated README with cost tracking and guarded clients sections |
| 58 | +- Added 5 comprehensive example scripts |
| 59 | +- Full API documentation for all new classes |
| 60 | +- Migration guide from v0.2.0 |
| 61 | + |
| 62 | +### Dependencies |
| 63 | +- Added `openai>=1.0.0` for GuardedOpenAI and GuardedAzureOpenAI |
| 64 | +- Added `anthropic>=0.18.0` for GuardedAnthropic |
| 65 | +- Added `hypothesis>=6.0.0` for property-based testing (dev) |
| 66 | + |
| 67 | +### Testing |
| 68 | +- 71+ new tests for cost tracking and guarded clients |
| 69 | +- Property-based tests for correctness validation |
| 70 | +- Integration tests for end-to-end workflows |
| 71 | +- 61% overall test coverage (focused on new features) |
| 72 | + |
| 73 | +### Notes |
| 74 | +- **Feature Parity**: Python SDK now matches TypeScript SDK v0.2.2 |
| 75 | +- **Breaking Changes**: None - fully backward compatible |
| 76 | +- **Migration**: Existing code continues to work without changes |
| 77 | + |
| 78 | +## [0.2.0] - 2026-01-30 |
| 79 | + |
| 80 | +### Added |
| 81 | +- **Client-Side Guardrails** - Offline security protection without server dependency |
| 82 | + - `GuardrailEngine` for parallel/sequential guardrail execution |
| 83 | + - `PIIDetectionGuardrail` - Detect and redact PII (emails, phones, SSNs, credit cards) |
| 84 | + - `ContentModerationGuardrail` - Detect harmful content (hate, violence, harassment) |
| 85 | + - `PromptInjectionGuardrail` - Detect jailbreak and injection attempts |
| 86 | + - Configurable actions: block, allow, redact, mask, transform |
| 87 | + - Timeout protection and error handling with asyncio |
| 88 | + - Pydantic models for type safety |
| 89 | +- Comprehensive test suite for guardrails (50 tests passing) |
| 90 | +- Guardrails demo example with real-world scenarios |
| 91 | +- Full async/await support for all guardrail operations |
| 92 | + |
| 93 | +### Features |
| 94 | +- **Offline Capability**: Run guardrails without network calls |
| 95 | +- **Parallel Execution**: Execute multiple guardrails simultaneously with asyncio |
| 96 | +- **Flexible Actions**: Block, redact, mask, or transform risky content |
| 97 | +- **Risk Scoring**: Quantify security risks (0-100 scale) |
| 98 | +- **Pattern Detection**: Regex-based detection with high accuracy |
| 99 | +- **OpenAI Integration**: Optional OpenAI Moderation API support |
| 100 | +- **Type Safety**: Full Pydantic models for all guardrail results |
| 101 | + |
| 102 | +### Performance |
| 103 | +- < 50ms guardrail execution (parallel mode) |
| 104 | +- Configurable timeouts per guardrail |
| 105 | +- Efficient pattern matching with compiled regex |
| 106 | +- Async-first design for high concurrency |
| 107 | + |
| 108 | +### Documentation |
| 109 | +- Added guardrails usage examples |
| 110 | +- Updated README with guardrails showcase |
| 111 | +- Added inline documentation for all guardrail classes |
| 112 | + |
| 113 | +## [0.1.1] - 2026-01-29 |
| 114 | + |
| 115 | +### Fixed |
| 116 | +- Package name changed to `agentguard-sdk` (from `agentguard`) due to PyPI name conflict |
| 117 | +- Updated all imports and documentation |
| 118 | + |
| 119 | +### Added |
| 120 | +- Published to PyPI as `agentguard-sdk` |
| 121 | +- GitHub repository: https://github.com/agentguard-ai/agentguard-python |
| 122 | + |
| 123 | +## [0.1.0] - 2026-01-28 |
| 124 | + |
| 125 | +### Added |
| 126 | +- Initial release of AgentGuard Python SDK |
| 127 | +- Core security evaluation functionality |
| 128 | +- Tool execution with security decisions (allow/deny/transform) |
| 129 | +- Security Sidecar Agent (SSA) HTTP client |
| 130 | +- Configuration management with validation |
| 131 | +- Comprehensive error handling with custom exceptions |
| 132 | +- Audit trail functionality |
| 133 | +- Policy validation and management |
| 134 | +- Full async/await support |
| 135 | +- Type hints throughout the codebase |
| 136 | +- Comprehensive test suite with pytest |
| 137 | +- Examples for basic and advanced usage |
| 138 | +- Complete API documentation |
| 139 | + |
| 140 | +### Features |
| 141 | +- **Security Evaluation**: Evaluate tool calls before execution |
| 142 | +- **Policy Enforcement**: Automatic policy-based decision making |
| 143 | +- **Request Transformation**: Safe transformation of risky operations |
| 144 | +- **Audit Trail**: Complete audit logging for compliance |
| 145 | +- **Performance**: < 100ms security evaluation overhead |
| 146 | +- **Type Safety**: Full type hints with Pydantic models |
| 147 | +- **Async Support**: Built-in async/await for modern Python |
| 148 | + |
| 149 | +### Security |
| 150 | +- API key authentication with SSA |
| 151 | +- Input validation and sanitization |
| 152 | +- Secure HTTP communication with httpx |
| 153 | +- Error handling that doesn't leak sensitive information |
| 154 | + |
| 155 | +### Developer Experience |
| 156 | +- Comprehensive documentation with examples |
| 157 | +- Type hints for better IDE support |
| 158 | +- Pytest test suite with 100% core functionality coverage |
| 159 | +- Examples for common integration patterns |
| 160 | +- Poetry and pip support |
| 161 | + |
| 162 | +[Unreleased]: https://github.com/agentguard-ai/agentguard-python/compare/v0.2.2...HEAD |
| 163 | +[0.2.2]: https://github.com/agentguard-ai/agentguard-python/releases/tag/v0.2.2 |
| 164 | +[0.2.0]: https://github.com/agentguard-ai/agentguard-python/releases/tag/v0.2.0 |
| 165 | +[0.1.1]: https://github.com/agentguard-ai/agentguard-python/releases/tag/v0.1.1 |
| 166 | +[0.1.0]: https://github.com/agentguard-ai/agentguard-python/releases/tag/v0.1.0 |
0 commit comments