feat(ai-service): standardize result envelope across AI endpoints (#609)#4
Merged
Merged
Conversation
…lsefy#609) Add ResultEnvelope base class with result, confidence, reasons, anchor_metadata and trace_id fields. Compose into all v1 response schemas (OCR, fraud, anonymize, humanitarian, proof-of-life) and populate the fields in every endpoint handler. All envelope fields are Optional so existing callers see no breaking changes. trace_id is auto-generated (UUID4) per request. - schemas/envelope.py – new ResultEnvelope Pydantic mixin - schemas/ocr.py – OCRResponse extends ResultEnvelope - schemas/fraud.py – FraudDetectionResponse extends ResultEnvelope - schemas/anonymization.py – AnonymizeResponse extends ResultEnvelope - schemas/humanitarian.py – HumanitarianVerificationResponse extends ResultEnvelope - api/v1/ocr.py – populate envelope (avg confidence, filename anchor) - api/v1/fraud.py – populate envelope (risk-derived confidence, flagged IDs) - api/v1/anonymize.py – populate envelope (rule-based, PII count anchor) - api/v1/humanitarian.py – populate envelope (verdict confidence, provider anchor) - api/v1/proof_of_life.py – populate envelope (confidence passthrough, checks anchor) - tests/test_result_envelope.py – schema + endpoint envelope validation tests
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add ResultEnvelope base class with result, confidence, reasons, anchor_metadata and trace_id fields. Compose into all v1 response schemas (OCR, fraud, anonymize, humanitarian, proof-of-life) and populate the fields in every endpoint handler.
All envelope fields are Optional so existing callers see no breaking changes. trace_id is auto-generated (UUID4) per request.
closes Pulsefy#609