VisionModels vision.models@1

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

Version
1.0.0
Owner
vision
Visibility
public
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/vision/models.v1.json

vision.models@1: GET /api/v1/models names the AI route's offered provider:model hints, the configured hints and the local engines present, without any subject data. OpenVibe.AI's router remains the authority: this is a menu, not a promise.

Fields

FieldTypeRequiredDescriptionConstraints
aibooleanyes
configuredarray of stringyes
offeredarray of objectyes
localarray of stringyes
notestringyes

Examples

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

Valid: one
{
  "ai": true,
  "configured": [
    "openai:gpt-4o-mini"
  ],
  "offered": [
    {
      "provider": "openai",
      "model": "gpt-4o-mini"
    }
  ],
  "local": [
    "tesseract",
    "histogram"
  ],
  "note": "provider:model hints"
}
Rejected: one
{
  "ai": true,
  "configured": "openai:gpt-4o-mini",
  "offered": [],
  "local": [],
  "note": "x"
}

Validate

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