Skip to content

VideoMomentSearchHitDto

Endpoints · All schemas

FieldRequiredDescription
assetIdYesstring
captionYesstring
frameIdYesstring
matchYesSee definition below
momentIdYesstring
scoreYesHigher is closer
timestampMsYesinteger

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: VideoMomentMatch

{
  "properties": {
    "assetId": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "caption": {
      "nullable": true,
      "type": "string"
    },
    "frameId": {
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "match": {
      "$ref": "#/components/schemas/VideoMomentMatch"
    },
    "momentId": {
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "score": {
      "description": "Higher is closer",
      "format": "double",
      "type": "number"
    },
    "timestampMs": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    }
  },
  "required": [
    "assetId",
    "caption",
    "frameId",
    "match",
    "momentId",
    "score",
    "timestampMs"
  ],
  "type": "object"
}