QVAC-23971 feat[api]: describe OCR modelConfig fields - #4062
Open
lauripiisang wants to merge 1 commit into
Open
Conversation
Contributor
Review StatusCurrent Status: ❌ PENDING Pending reviews: Needs 1 Management or Team Lead, and 1 more from Management, Team Lead, or Member. |
Contributor
License compliance — cleanNo new dependency license findings in this PR. Warn-only (shadow) mode — this check does not block merges yet. Updated automatically by the canonical license compliance workflow. NOTICE presence (advisory)Missing NOTICE (advisory, does not block):
|
simon-iribarren
previously approved these changes
Aug 26, 2026
- Add .describe() to every ocrConfigSchema field (langList, pipelineType, magRatio, canvasSize, defaultRotationAngles, contrastRetry, lowConfidenceThreshold, recognizerBatchSize, nThreads, backendDevice, gpuDevice, detectorModelSrc) - Sourced from @qvac/ocr-ggml index.d.ts (OcrGgmlParams); detectorModelSrc noted as derived from the recognizer source when omitted - Regenerate contract/schema.json and the Python generated models
lauripiisang
force-pushed
the
QVAC-23971-describe-ocr
branch
from
August 26, 2026 14:35
294e528 to
12c732e
Compare
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
2 participants
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.
🎯 What problem does this PR solve?
ggml-ocr)modelConfigfields shipped without descriptions, so the generated contract (contract/schema.json) — consumed byqvac configure, the typed-client generators, and the Python generator — couldn't say what any field means.📝 How does it solve it?
.describe()to everyocrConfigSchemafield:langList,pipelineType,magRatio,canvasSize,defaultRotationAngles,contrastRetry,lowConfidenceThreshold,recognizerBatchSize,nThreads,backendDevice,gpuDevice,detectorModelSrc.@qvac/ocr-ggmlindex.d.ts(OcrGgmlParamsJSDoc) — no invented semantics.detectorModelSrcis noted as derived from the recognizer model source when omitted.contract/schema.jsonand the Python generated models.Part of QVAC-23933.
🧪 How was it tested?
bun run contract:exportregenerated;contract:check,typecheck,lint,format, and fulltest:unit(incl. contract-export freshness) pass.packages/inferencetypecheck+lintpass.packages/sdk-pythongenerate.py --checkpasses.🔌 API Changes
Additive only: