VisionFaceFindResult vision.face-find-result@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/face-find-result.v1.json

vision.face-find-result@1: POST /api/v1/faces/find lists the caller's own private uploads that match their enrolled self-search template, as private links and scores. It requires find consent; without it the answer is faces.consent_required whether or not any media exists.

Fields

FieldTypeRequiredDescriptionConstraints
resultsarray of objectyes
  • maxItems 500
  • items: no other fields
results[].private_linkstringyes
  • pattern ^/api/v1/faces/media/
results[].scorenumberyes
  • minimum 0
  • maximum 1

Examples

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

Valid: one
{
  "results": [
    {
      "private_link": "/api/v1/faces/media/fme_01J8Z3Q4R5S6T7V8W9X0Y1Z2A4",
      "score": 0.66
    }
  ]
}
Rejected: one
{
  "results": [
    {
      "private_link": "https://openvibe.vision/public/x",
      "score": 0.66
    }
  ]
}

Validate

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