ClassificationPreviewResponseDto

Endpoints · All schemas

Field	Required	Description
exact	Yes	True when `matched` counts the whole library, false for a bounded sample
items	Yes	The first matches, best first
matched	Yes	Items that match among those read
sampled	Yes	Items read: the whole library when exact, otherwise the newest items
visualSearchAvailable	Yes	False when visual phrases cannot be compared right now

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

{
  "properties": {
    "exact": {
      "description": "True when `matched` counts the whole library, false for a bounded sample",
      "type": "boolean"
    },
    "items": {
      "description": "The first matches, best first",
      "items": {
        "$ref": "#/components/schemas/ClassificationScoredAssetDto"
      },
      "type": "array"
    },
    "matched": {
      "description": "Items that match among those read",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "sampled": {
      "description": "Items read: the whole library when exact, otherwise the newest items",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "visualSearchAvailable": {
      "description": "False when visual phrases cannot be compared right now",
      "type": "boolean"
    }
  },
  "required": [
    "exact",
    "items",
    "matched",
    "sampled",
    "visualSearchAvailable"
  ],
  "type": "object"
}