docs: update API Ref (V4.2), CHANGELOG, Release Notes for de88fd4e

This commit is contained in:
Accusys
2026-05-25 10:31:32 +08:00
parent de88fd4e44
commit b9e93c6293
4 changed files with 237 additions and 77 deletions

View File

@@ -1,7 +1,7 @@
# Release Notes — v1.0.0 (Production 3002)
# Release Notes — v1.0.1 (Production 3002)
**Date**: 2026-05-13
**Build**: `301da08`
**Date**: 2026-05-25
**Build**: `de88fd4e`
**Deployed by**: M4
---
@@ -101,6 +101,36 @@
---
## Changes Since v1.0.0 (301da08 → de88fd4e)
### Added
- POST `/api/v1/agents/search` — Gemma4 function calling agent
- POST `/api/v1/identity/:uuid/bind/trace` — trace-level identity binding
- GET `/api/v1/file/:uuid/identities/:a/co-occur-with/:b` — co-occurrence
- GET `/api/v1/file/:uuid/trace/:tid/thumbnail` — trace thumbnail
- GET `/api/v1/file/:uuid/trace/:tid/representative-face` — representative face
- PATCH `/api/v1/identity/:identity_uuid` — identity update + alias system
- TKG extension: pose data + mutual gaze detection
- `/health/consistency` — data consistency check
- Config endpoints: cache toggle, auto-pipeline, watcher-auto-register
- Representative frame auto-detection
### Fixed
- System consistency: store_vector, search, worker trigger reliability
- trigger_processing: remove fake QUEUED state, create monitor_job if missing
- stranger_id set to NULL on bind/merge operations
- frame_number type: i32→i64 to match BIGINT schema
- Compilation errors: restored PipelineType enum, pipeline() method, constants
### Changed
- Unified LLM config: CHAT_URL/VISION_URL/SUMMARY_URL with env var overrides
- Port config centralized (8082 conflict resolved)
- Resources API returns data (config+metadata)
- server.rs split into modular route files
- API Reference: 55 endpoints, removed phantom routes, fixed methods, renamed endpoints
---
## Known Notes
| Item | Note |

View File

@@ -6,13 +6,135 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [Unreleased]
### Fixed
- Compilation errors: restore PipelineType enum, pipeline() method, OLLAMA_URL/EMBED_URL/LLM_HEALTH_URL constants
- frame_number type: changed i32→i64 to match BIGINT schema
## [1.0.1] - 2026-05-25
### Fixed
- System consistency: store_vector, search, worker trigger reliability
- trigger_processing: remove fake QUEUED state, create monitor_job if missing
- stranger_id set to NULL on bind/merge operations
- resource path cleanup
### Added
- Gitea API token integration
- n8n API key integration
- API key caching with Moka
- Rate limiting for API key validation
- Constant-time hash comparison
- OpenAPI documentation with utoipa
- Frame/time pipeline split with output validation
- `/api/v1/agents/search` — Gemma4 function calling agent
- `/api/v1/identity/:uuid/bind/trace` — trace-level identity binding
- `/api/v1/file/:uuid/identities/:a/co-occur-with/:b` — co-occurrence endpoint
- `/api/v1/file/:uuid/trace/:tid/thumbnail` — trace thumbnail
- `/api/v1/file/:uuid/trace/:tid/representative-face` — representative face
- identity PATCH update, alias system, name UNIQUE removal
- TKG extension: pose data + mutual gaze detection
### Changed
- Unified LLM config: CHAT_URL/VISION_URL/SUMMARY_URL with env var overrides
- Refactored server.rs into modular route files
- Port config centralized (8082 conflict resolved)
- Resources API returns data (config+metadata); register source code resource
## [1.0.0] - 2026-05-14
### Added
- Release version v1.0.0 tag
- Production binary at port 3002
- Playground binary at port 3003
- Dedicated Gitea sync pipeline
### Changed
- Full V4.0 API reference published (55 endpoints)
- Health APIs include build_timestamp + resources + pipeline
- Qdrant refactored to use i64 for frame_number
- Rust edition 2021, max_width=100, tab_spaces=4
## [0.6.0] - 2026-05-01
### Added
- `/api/v1/agents/translate` — AI text translation
- `/api/v1/agents/5w1h/batch` — batch analysis
- `/api/v1/agents/identity/match-from-photo` — face matching from photo
- `/api/v1/agents/identity/match-from-trace` — face matching from trace
- `/api/v1/agents/suggest/merge` — merge suggestions
- `/api/v1/agents/suggest/clustering` — re-clustering suggestions
- `/api/v1/search/visual` endpoints (class, density, combination, stats)
- `/api/v1/search/frames` — frame-level search
- `/api/v1/faces/candidates` — unbound face gallery
- `/api/v1/identities/search` — identity name search
- `/api/v1/search/identity_text` — full-text identity-bound chunk search
- `/health/consistency` — data consistency check
- Config endpoints: auto-pipeline toggle, watcher-auto-register toggle
- Cache toggle via `/api/v1/config/cache`
### Fixed
- Various type mismatches in DB layer (i64/i32 alignment)
- Trace debug mode bbox rendering
- Interpolation for sparse face detections
## [0.5.0] - 2026-04-15
### Added
- `/api/v1/file/:file_uuid/traces` — trace listing (replaces face_trace/sortby)
- `/api/v1/file/:file_uuid/trace/:trace_id/faces` — trace detections with interpolation
- `/api/v1/file/:file_uuid/video/bbox` — bbox overlay video
- `/api/v1/file/:file_uuid/trace/:trace_id/video` — trace clip (normal/debug mode)
- File probe endpoint (`/api/v1/file/:file_uuid/probe`)
- Jobs monitoring (`/api/v1/jobs`)
- Processing progress (`/api/v1/progress/:file_uuid`)
- Chunk detail (`/api/v1/file/:file_uuid/chunk/:chunk_id`)
- `/api/v1/unregister` — file unregistration by uuid or pattern
### Changed
- face_trace/sortby renamed to `/api/v1/file/:file_uuid/traces`
- Chunk/progress/jobs endpoints changed from GET to POST
- Qdrant MongoDB dependency replaced with Rust-native driver
- Redis upgraded to 1.0.x for performance
## [0.4.0] - 2026-04-01
### Added
- Identity management: register, detail, delete, files, chunks
- Identity binding: bind/unbind face → identity
- Identity merging: mergeinto endpoint
- Resource management: register, heartbeat, list
- Docker health check integration
- SFTPGo status endpoint
- Pagination support for list endpoints
### Changed
- Database schema: `person_identities` table removed
- N:N relationship via `file_identities` table
- Architecture shift: Face → Identity (two-layer direct binding)
- Terminology: `video_uuid``file_uuid` across all APIs
## [0.3.0] - 2026-03-25
### Added
- `/api/v1/search/universal` — BM25 keyword search
- `/api/v1/search/smart` — semantic search (pgvector)
- `/api/v1/files/register` — file registration
- `/api/v1/files/lookup` — name conflict check
- `/api/v1/files/scan` — directory scan
- File listing and detail endpoints
- POST `/api/v1/file/:file_uuid/process` — processing pipeline trigger
- `/api/v1/auth/login` and `/api/v1/auth/logout`
- `/health/detailed` — per-service health check
### Changed
- Video processing pipeline refactored (ASR, OCR, YOLO, Face, Pose)
- Centralized Python executor with timeout support
- Logging unified under `logs/` directory
- Startup scripts auto-build and kill old processes
## [0.2.0] - 2026-03-22
### Added
- `/health` endpoint with status/build info
- Video stream endpoint (`/api/v1/file/:file_uuid/video`)
- Thumbnail extraction endpoint
- FaceNet CoreML model integration
- Basic API key authentication
- PostgreSQL, MongoDB, Redis, Qdrant service initialization
## [0.1.0] - 2026-03-21
@@ -140,4 +262,11 @@ N8N_URL=https://n8n.momentry.ddns.net
| Version | Date | Description |
|---------|------|-------------|
| 1.0.1 | 2026-05-25 | Bug fixes, agent endpoints, identity alias system, TKG extension |
| 1.0.0 | 2026-05-14 | Release v1.0.0, V4.0 API reference, production binary |
| 0.6.0 | 2026-05-01 | Agent endpoints (translate, 5w1h, identity match), search visual endpoints |
| 0.5.0 | 2026-04-15 | Traces API, media endpoints, jobs/progress/chunk, rename face_trace→traces |
| 0.4.0 | 2026-04-01 | Identity management, resource API, video_uuid→file_uuid rename |
| 0.3.0 | 2026-03-25 | Search (BM25/semantic), file registration, health check, auth |
| 0.2.0 | 2026-03-22 | Health endpoint, video stream, thumbnail, FaceNet model, DB init |
| 0.1.0 | 2026-03-21 | Initial release with API Key Management |