ClassificationPreviewDto

Endpoints · All schemas

Field	Required	Description
mediaType	No	See definition below
personIds	No	Match any of these people
sampleSize	No	How many of the newest items a visual preview reads
tagIds	No	Match any of these tags, or a tag beneath one of them
takenAfter	No	Taken on or after this day (YYYY-MM-DD)
takenBefore	No	Taken on or before this day (YYYY-MM-DD)
threshold	No	The confidence a visual phrase has to reach
visualQueries	No	Visual category phrases compared with each item

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: ClassificationMediaType

{
  "properties": {
    "mediaType": {
      "$ref": "#/components/schemas/ClassificationMediaType",
      "default": "any"
    },
    "personIds": {
      "default": [],
      "description": "Match any of these people",
      "items": {
        "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"
      },
      "maxItems": 50,
      "type": "array"
    },
    "sampleSize": {
      "default": 500,
      "description": "How many of the newest items a visual preview reads",
      "maximum": 2000,
      "minimum": 1,
      "type": "integer"
    },
    "tagIds": {
      "default": [],
      "description": "Match any of these tags, or a tag beneath one of them",
      "items": {
        "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"
      },
      "maxItems": 50,
      "type": "array"
    },
    "takenAfter": {
      "default": null,
      "description": "Taken on or after this day (YYYY-MM-DD)",
      "nullable": true,
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "type": "string"
    },
    "takenBefore": {
      "default": null,
      "description": "Taken on or before this day (YYYY-MM-DD)",
      "nullable": true,
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "type": "string"
    },
    "threshold": {
      "default": 0.25,
      "description": "The confidence a visual phrase has to reach",
      "format": "double",
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "visualQueries": {
      "default": [],
      "description": "Visual category phrases compared with each item",
      "items": {
        "maxLength": 120,
        "minLength": 1,
        "type": "string"
      },
      "maxItems": 10,
      "type": "array"
    }
  },
  "type": "object"
}