VisionReceiptRequest vision.receipt-request@1

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

Version
1.0.0
Owner
vision
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/vision/receipt-request.v1.json

vision.receipt-request@1: the body of POST /api/v1/receipt. The local OCR reader extracts line items and a total; `fallback` asks OpenVibe.AI only when the local pass could not produce both.

Fields

FieldTypeRequiredDescriptionConstraints
imagestringThe image as a data URL (base64).
  • pattern ^data:image/
image_urlstringA public image URL, fetched through Vision's private-address guard.
  • pattern ^https?://
  • format uri
fallbackboolean

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: one
{
  "image": "data:image/png;base64,iVBORw0KGgo=",
  "fallback": false
}
Rejected: one
{
  "image": "data:image/png;base64,iVBORw0KGgo=",
  "fallback": "yes"
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('vision.receipt-request@1', value);   // { valid, errors: [{ path, message }] }