VisionFindResult vision.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/find-result.v1.json

vision.find-result@1: POST /api/v1/index and GET/POST /api/v1/find answer a scoped private search over the caller's own indexed items: `results` (item_id, result_url, score) only, no one else's rows and no public index.

Fields

FieldTypeRequiredDescriptionConstraints
answerobjectyes
  • no other fields
answer.resultsarray of objectyes
  • maxItems 5000
  • items: no other fields
answer.results[].item_idstringyes
answer.results[].result_urlstring | null
  • pattern ^https://
  • format uri
answer.results[].scorenumberyes
answer.receiptobjectyes
  • no other fields
answer.receipt.engineenumyes
  • one of "local", "routed", "local+routed", "local+routed description"
answer.receipt.modelstring | nullyes
answer.receipt.cost_usdnumberyes
  • minimum 0
answer.receipt.msintegeryes
  • minimum 0
answer.receipt.confidencenumber | nullyes
answer.receipt.retentionstringyes

Examples

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

Valid: one
{
  "answer": {
    "results": [
      {
        "item_id": "media:42",
        "result_url": "https://openvibe.media/m/42",
        "score": 0.81
      }
    ],
    "receipt": {
      "engine": "local",
      "model": "CLIP ViT-B/32 q8",
      "cost_usd": 0,
      "ms": 12,
      "confidence": 0.81,
      "retention": "query not stored; indexed embeddings stored"
    }
  }
}
Rejected: one
{
  "answer": {
    "results": [
      {
        "item_id": "x",
        "result_url": "http://insecure.example/a",
        "score": 0.5
      }
    ],
    "receipt": {
      "engine": "local",
      "model": null,
      "cost_usd": 0,
      "ms": 1,
      "confidence": null,
      "retention": "x"
    }
  }
}

Validate

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