VideoJob

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-video-job-schema.json",
  "title": "VideoJob",
  "description": "Job details for a video analysis.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-aiservicevision-api-openapi.yml#/components/schemas/VideoJob",
  "properties": {
    "compartmentId": {
      "description": "The ocid of the compartment that starts the job.",
      "type": "string"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer, and boolean types are supported.\n",
          "type": "object"
        },
        "description": "A key-value pair representing predefined tags' keys and values scoped to a namespace.\nFor example: `{\"bar-key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
      "type": "object"
    },
    "displayName": {
      "description": "Video job display name.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "features": {
      "description": "a list of document analysis features.",
      "items": {
        "$ref": "#/$defs/VideoFeature"
      },
      "minItems": 1,
      "type": "array"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.\nFor example: `{\"bar-key\": \"value\"}`\n",
      "type": "object"
    },
    "id": {
      "description": "Id of the job.",
      "type": "string"
    },
    "inputLocation": {
      "$ref": "#/$defs/InputLocation"
    },
    "lifecycleDetails": {
      "description": "Detailed status of FAILED state.",
      "enum": [
        "PARTIALLY_SUCCEEDED",
        "COMPLETELY_FAILED"
      ],
      "type": "string"
    },
    "lifecycleState": {
      "description": "The current state of the video job.",
      "enum": [
        "SUCCEEDED",
        "FAILED",
        "ACCEPTED",
        "CANCELED",
        "IN_PROGRESS",
        "CANCELING"
      ],
      "type": "string"
    },
    "outputLocation": {
      "$ref": "#/$defs/OutputLocation"
    },
    "percentComplete": {
      "description": "How much progress the operation has made, vs the total amount of work that must be performed.",
      "format": "float",
      "maximum": 100,
      "minimum": 0,
      "type": "number"
    },
    "systemTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer, and boolean types are supported.\n",
          "type": "object"
        },
        "description": "A key-value pair representing system tags' keys and values scoped to a namespace.\nFor example: `{\"bar-key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "Usage of system tag keys. These predefined keys are scoped to namespaces.\nFor example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
      "type": "object"
    },
    "timeAccepted": {
      "description": "Job accepted time.",
      "format": "date-time",
      "type": "string"
    },
    "timeFinished": {
      "description": "Job finished time.",
      "format": "date-time",
      "type": "string"
    },
    "timeStarted": {
      "description": "Job started time.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "compartmentId",
    "features",
    "timeAccepted",
    "outputLocation",
    "lifecycleState"
  ],
  "type": "object",
  "$defs": {
    "InputLocation": {
      "description": "The location of the inputs.",
      "properties": {
        "sourceType": {
          "description": "The type of input location.\nThe allowed values are:\n- `OBJECT_LIST_INLINE_INPUT_LOCATION`: A list of object locations in Object Storage.\n",
          "enum": [
            "OBJECT_LIST_INLINE_INPUT_LOCATION"
          ],
          "type": "string"
        }
      },
      "required": [
        "sourceType"
      ],
      "type": "object"
    },
    "OutputLocation": {
      "description": "The Object Storage Location.",
      "properties": {
        "bucketName": {
          "description": "The Object Storage bucket name.",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "namespaceName": {
          "description": "The Object Storage namespace.",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "prefix": {
          "description": "The Object Storage folder name.",
          "maxLength": 1024,
          "minLength": 0,
          "type": "string"
        }
      },
      "required": [
        "namespaceName",
        "bucketName",
        "prefix"
      ],
      "type": "object"
    },
    "VideoFeature": {
      "description": "Details about a video feature request.",
      "properties": {
        "featureType": {
          "description": "The feature of video analysis.\nAllowed values are:\n- LABEL_DETECTION: Label detection feature(IC).\n- OBJECT_DETECTION: Object detection feature(OD).\n- TEXT_DETECTION: Text detection feature(OCR).\n- FACE_DETECTION: Face detection feature(fd).\n- OBJECT_TRACKING: Object tracking feature(OT).\n",
          "enum": [
            "LABEL_DETECTION",
            "OBJECT_DETECTION",
            "TEXT_DETECTION",
            "FACE_DETECTION",
            "OBJECT_TRACKING"
          ],
          "type": "string"
        }
      },
      "required": [
        "featureType"
      ],
      "type": "object"
    }
  }
}