API Reference
Guides

Image Scene Classification

Classifies the scene of an image asset and provides a list of possible scene labels and their confidence scores. Labels returned will be ranked by confidence score in descending order.

🚧

Note: This API is not generally available. Please contact us to get access to this API.

📘

For training custom scene labels, please contact your FileSpin representative.

Note

  • This API can be used to automatically update Asset metadata with the labels under a reserved field named _filespin_scene_labels using the update_metadata disposition option.
  • When an asset is updated for the reserved field named _filespin_scene_labels, this field value will be automatically indexed for search.
  • If your asset schema is defined to have _filespin_scene_labels, ensure that this is a string type field and the maxLength is set to atleast 100, like below:-
"_filespin_scene_labels": {
        "title": "Image Scene Tags",
        "type": "string",
        "description": "Possible places this ",
        "minLength": 0,
        "maxLength": 100,
        "filespin_properties": {
          "title": {
            "en": "Theme that is available on the guest asset"
          },
          "hint": {
            "en": "Theme that is available on the guest asset"
          },
          "placeholder": {
            "en": "Theme that is available on the guest asset"
          },
          "searchable": true,
          "keyword_searchable": true,
          "filterable": false,
          "facetable": false,
          "ui": {
            "order": 36,
            "readonly": false,
            "disabled": false,
            "hidden": false
          }
        }
      }