LiveIndexDocumentUpsertedPayload live.index_document.upserted@1

Generated at from openvibe-contracts v0.114.0 and openvibe-sdk v0.35.1.

Version
1.0.0
Owner
live
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/events/payloads/live.index_document.upserted.v1.json

live.index_document.upserted v1 (OpenVibe.Live server/events/search-documents.js; roadmap WS-O task 10). The OpenVibe.Search document of one of Live's canonical pages: a streamer's channel (type channel, openvibe.live/@username: its name, bio, what it streams and whether it is live), or a public VOD or clip of a Live stream (types vod and clip, openvibe.live/vod/<id> and /clip/<id>: title, channel, AI overview and transcript; the id is the Media id; AI clips are noindex). Sent whenever what Search should hold changed; a banned channel, or a VOD or clip that is deleted, made private or failed, gets a tombstone. The revision grows with every change. Consumed by OpenVibe.Search ('*.index_document.*'). Envelope: subject { type, id, revision: <document revision> }, visibility internal, actor service:live.

Fields

This schema has no named fields.

Examples

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

Valid: ai-clip
{
  "owner": "live",
  "type": "clip",
  "id": "3107",
  "revision": 1,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://openvibe.live/clip/3107",
  "title": "Chat erupts at the boss fight",
  "summary": "AI clip from Alex's stream.",
  "facets": {
    "channel": "alex",
    "ai_clip": true,
    "vod_id": "912",
    "duration_seconds": 30
  },
  "authorship": "ai_generated",
  "publication_state": "published",
  "published_at": "2026-09-24T21:00:00.000Z",
  "updated_at": "2026-09-25T19:00:00.000Z",
  "indexability": {
    "decision": "noindex",
    "reasons": [
      "ai_unreviewed"
    ]
  }
}
Valid: channel
{
  "owner": "live",
  "type": "channel",
  "id": "42",
  "revision": 3,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://openvibe.live/@alex",
  "title": "Alex (@alex)",
  "summary": "Streams builds and games.",
  "body": "Streams builds and games.\nLast stream: Building a forum",
  "facets": {
    "category": "tech",
    "live": false,
    "followers": 12
  },
  "language": "en",
  "authorship": "human",
  "publication_state": "published",
  "published_at": "2026-09-01T10:00:00.000Z",
  "updated_at": "2026-09-25T19:00:00.000Z",
  "indexability": {
    "decision": "index"
  }
}
Valid: vod
{
  "owner": "live",
  "type": "vod",
  "id": "912",
  "revision": 2,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://openvibe.live/vod/912",
  "title": "Building a forum",
  "summary": "Alex builds the forum's rating menu and fixes it on phones.",
  "body": "Transcript: okay so today we are building the forum",
  "facets": {
    "channel": "alex",
    "category": "tech",
    "duration_seconds": 5400
  },
  "language": "en",
  "authorship": "human",
  "publication_state": "published",
  "published_at": "2026-09-24T19:00:00.000Z",
  "updated_at": "2026-09-25T19:00:00.000Z",
  "indexability": {
    "decision": "index"
  }
}
Rejected: paste-type
{
  "owner": "live",
  "type": "paste",
  "id": "12",
  "revision": 1,
  "deleted": false,
  "visibility": "public",
  "canonical_url": "https://openvibe.live/p/x",
  "title": "x",
  "publication_state": "published"
}

Validate

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