- Major versions introduce breaking changes to the API or SDK interfaces
- Minor versions add new features in a backward-compatible manner
- Patch versions contain backward-compatible bug fixes
v0.1.2 — 2025-01-15
Added
- Entity Resolution integration: The ingestion pipeline now resolves entities across conversations. Mentions of the same entity (e.g., “John”, “John Smith”, “my manager”) are linked to a canonical entity record.
- Review queue for entity resolution: Ambiguous entity matches are routed to a review queue for human verification via the Dashboard.
- Auto-registration of unresolved entities: New entities that do not match any existing record are automatically registered at the CUSTOMER scope for future lookups.
- Semantic entity matching: Entity resolution uses semantic similarity matching, catching variations that exact string matching would miss.
Changed
- Entity resolution is now integrated before persistence in the ingestion flow.
- Entity resolution runs as a graceful degradation feature — if unavailable, the pipeline continues without resolution and logs a warning.
Fixed
- Fixed non-deterministic test behavior caused by Python set iteration order in pipeline stage tests.
v0.1.1 — 2025-01-10
Added
- Memory Architecture Configuration (MACA) system: Full configuration lifecycle with init, update, review, apply, and rollback operations.
- Admin API Groups A-D: Client lifecycle (10 endpoints), instance lifecycle (12 endpoints), config management (10 endpoints), and setup/onboarding (6 endpoints).
- Dashboard API routes: Configuration detail and history endpoints for the web UI.
- Configuration persistence and workflow improvements: Added storage and workflow support for configuration metadata, approvals, and history.
- Configuration validation improvements: Stronger schema and business-rule validation for submitted configuration files.
- Setup and architecture management improvements: Better onboarding and dashboard-facing configuration management flows.
Changed
- Admin API response shapes were standardized for consistency across dashboard routes.
- Configuration version numbers are parsed from semantic version strings (“1.0.0” becomes version
1).
Fixed
- Resolved circular import issues in
admin_api/__init__.pyby using lazy imports (inside methods) for cross-manager dependencies.
v0.1.0 — 2025-01-05
Added
- Initial release of the Synap SDK and API.
- Memory ingestion pipeline: Four-stage async pipeline (extraction, categorization, entity resolution, storage) with
fast,accurate, andbatchprocessing modes. - Context retrieval:
POST /v1/context/fetchwith vector search, graph traversal, and re-ranking. Supportsfast,balanced, andaccurateretrieval modes. - Context compaction:
POST /v1/context/compactwithsummarize,extract,hierarchical, andtemporalstrategies. - Instance management: Full CRUD for instances via the Dashboard API, including bootstrap key generation and revocation.
- API key authentication: Unified auth model — API keys (
synap_prefix) authenticate both REST and gRPC. Generate, list, and revoke keys via the Dashboard. - Cloud auth layer: Production-ready authentication and authorization foundation for SDK and dashboard operations.
- Memory Architecture Configurators: Initial configuration system for storage, ingestion, and retrieval controls.
- Scope system: Four-level scope chain (USER > CUSTOMER > CLIENT > WORLD) with proper isolation and inheritance.
- Webhook system: Five event types (
conversation.started,conversation.ended,context.retrieved,config.applied,compaction.completed) with HMAC-SHA256 signature verification. - Analytics: Usage metrics, latency percentiles, and token tracking with minute/hour/day rollup buckets.
- Python SDK: Fully async SDK with typed exceptions, automatic retries, and certificate rotation.
- PostgreSQL backend: Persistent storage for clients, instances, credentials, memories, and analytics data.
- Local development certificate tooling: Certificate support for local development workflows.
- Production key management integration: Cloud-integrated key management support.
Security
- API keys are securely stored and managed by Synap.
- API keys are handled using secure lifecycle controls.
- AuthContext is immutable once created, preventing tampering.
Versions prior to 1.0.0 may include breaking changes in minor version increments as the API stabilizes. We recommend pinning to a specific version in production and testing upgrades in staging first.