Object Recognition

Enabling Object Recognition

The feature works on a per-project basis and is currently in beta. Consider making a separate project via your dashboard and drop us a line with your feature request and the project’s Public API Key at sales@uploadcare.com.

How It Works

Once we enable Object Recognition for one of your projects, we analyze every image that goes there. Hence, you should upload at least one image to a recognition-enabled project to proceed.

You can either upload an image right in your dashboard by navigating to the “Files” section of your project or use Upload API.

Once an image is uploaded to a recognition-enabled project, you can make an API call to acquire a list of detected objects and related confidence levels.

Getting Image Info

Here’s where the technical details begin ⚙️ Feel free to reference this section of the document by using this link.

Object Recognition is performed automatically for every image that is uploaded to a recognition-enabled project. While this happens on upload, it can take some extra time after a file is_ready. We currently use AWS Rekognition for the analyses and plan adding options like Google Vision in the future.

Acquiring info on detected objects is performed via the Uploadcare REST API. Object Recognition will only work with the API v0.6, which is currently unreleased and requires explicit declaration.

To do so, you make file info requests to our API endpoint specifying the add_fields parameter.

The endpoint for requesting Object Recognition info is:

https://api.uploadcare.com/files/html

There are two methods for getting info on detected objects via GET requests, for multi-file and single-file cases:

GET /files/?add_fields=rekognition_info

or

GET /files/:uuid/?add_fields=rekognition_infohtml

Where:

• add_field parameter points our API to include rekognition_info, a list holding object classes and confidence levels, in the response JSON.
• :uuid identifies the unique image for which you are requesting info on detected objects.

curl -H "Accept: application/vnd.uploadcare-v0.6+json" \
     -H "Authorization: Uploadcare.Simple publickey:secretkey" \
     "https://api.uploadcare.com/files/:uuid/?add_fields=rekognition_info"bash

curl -H "Accept: application/vnd.uploadcare-v0.6+json" \
     -H "Authorization: Uploadcare.Simple publickey:secretkey" \
     "https://api.uploadcare.com/files/?add_fields=rekognition_info"bash

Response Example

Let’s request Object Recognition info for the cover image of this section. Here is how it looked like:

Once we make a single-file request that is properly authenticated, that’s a response JSON we get:

{
  "datetime_removed": null,
  "datetime_stored": "2018-08-07T05:31:47.326146Z",
  "datetime_uploaded": "2018-08-07T05:31:47.132454Z",
  "image_info": {
    "orientation": null,
    "sequence": false,
    "format": "JPEG",
    "height": 2432,
    "width": 3648,
    "geo_location": null,
    "datetime_original": null,
    "dpi": [
        72,
        72
    ]
  },
  "is_image": true,
  "is_ready": true,
  "mime_type": "image/jpeg",
  "original_file_url": "https://ucarecdn.com/af9b7f02-6cbe-45bd-9bb6-9c928bf8a72e/house-pond.jpg",
  "original_filename": "eberhard-grossgasteiger-767950-unsplash.jpg",
  "size": 2363253,
  "url": "https://api.uploadcare.com/files/af9b7f02-6cbe-45bd-9bb6-9c928bf8a72e/",
  "uuid": "af9b7f02-6cbe-45bd-9bb6-9c928bf8a72e",
  "variations": null,
  "video_info": null,
  "rekognition_info": {
    "Building": 0.63291,
    "House": 0.63291,
    "Housing": 0.63291,
    "Architecture": 0.63008,
    "Outdoors": 0.55667,
    "Cottage": 0.63291,
    "Pond": 0.55667,
    "Castle": 0.63008,
    "Moat": 0.63008,
    "Fort": 0.63008
  }
}json

As you can see in the response, highest confidence levels can be found in rekognition_info for Building, House, and Housing classes.

The possible values for rekognition_info are:

• null, the analysis has not yet finished.
• {}, Object Recognition was unable to identify any known objects in an image.
• {object0: confidence0, object1: confidence1, ...}, info on detected objects and related confidence levels.

The common use case with confidence levels would be setting a threshold based on which your system will then operate.

Recognition Results

Here are some examples analyzed via our Object Recognition. Resulting data look like lists wrapped in JSON.

You can find detected object classes like Town, Carrot, Balcony, and more.

The provided confidence levels are floating point numbers in the range from 0 to 1. Check out the levels for Urban and Building classes for the image below. Uploadcare points those are the prevailing things in it. If you prefer percents, just multiply those numbers by 100. It can then be interpreted as Uploadcare is 92% sure Building is in the following image:

"rekognition_info": {
  "Town": 0.91803,
  "City": 0.91803,
  "Nature": 0.56342,
  "High Rise": 0.81656,
  "Downtown": 0.86856,
  "Architecture": 0.79969,
  "Urban": 0.91803,
  "Building": 0.91803,
  "Landscape": 0.56342,
  "Skyscraper": 0.79969
}json

The second example shows how you can get some additional context from an image. We are 94% sure there are carrots in the image and with the same level of confidence those carrots are Vegetable and Food, good to know 😌

Those additional context layers are not just useful for categorizing content, but building some smart decision-making workflows for your system 🤓

"rekognition_info": {
  "Plant": 0.93765,
  "Flora": 0.93765,
  "Food": 0.93765,
  "Tree": 0.51218,
  "Produce": 0.93765,
  "Carrot": 0.93765,
  "Conifer": 0.51218,
  "Vegetable": 0.93765,
  "Ivy": 0.60237,
  "Vegetation": 0.50727
}json

The third example uncovers that you can go beyond objects like Balcony to recognizing patterns. Say, we know there are Ornament, Arabesque Pattern, and Brick in the image below 🖼️

"rekognition_info": {
  "Art": 0.60401,
  "Home Decor": 0.719,
  "Ornament": 0.60401,
  "Shutter": 0.719,
  "Arabesque Pattern": 0.60401,
  "Window": 0.719,
  "Curtain": 0.719,
  "Brick": 0.75331,
  "Window Shade": 0.719,
  "Balcony": 0.70572
}json