Skip to content

Energy Labels Recognition

PRICING BLOG

The Energy Labels Recognition service provides a system for identification european energy label images of household appliances. This system is able to identify, recognize and read energy labels. You can use several API endpoints:

  • for recognition if image is energy label or not /v2/recognize
  • for recognition between old energy label and new one /v2/recognize_old_new
  • for reading energy class from image /v2/read_class
  • for identification of energy label and reading actual energy class /v2/recognize_read_class

Please, see page API Calls and Credits for exact prices for individual API calls. The Energy Label service uses a flow of complex recognition models to tag each image, that's why the cost is higher than a simple image classification.

See it in action ...

  • You can test your images and see the result on Ximilar Platform!
  • Contact us at sales@ximilar.com or info@ximilar.com for more information, or if you need to recognize millions of images

Active the service in Ximilar App

In order to get access to the Energy Label service, please register at https://app.ximilar.com, upgrade your account to Business Plan and then click on the Energy Label tile on the main panel to make it accessible for your Ximilar account.

API reference

The API follows the general rules of Ximilar API as described in Section First steps.

Things to note

  • Please, note that the "_base64" data is not returned. Use "_id" or any other field to identify your image.
  • Maximum number of records/images that can be send to API in one request is 10.

Recognition endpoint: /v2/recognize

https://api.ximilar.com/energy-labels/v2/recognize

Given a list of image records, this method returns information if image is energy label or not.

Parameters:

  • records: list of photos to predict the tags for
    • must contain either of _url or _base64 field - see section image data for details

curl --request POST \
  --url https://api.ximilar.com/energy-labels/v2/recognize \
  --header 'Authorization: Token __API_AUTH_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data '{
  "records": [
    {
      "_url": "__URL_PATH__"
    }
  ]
}'

Returns:

  • HTTP error code 2XX, if the method was OK and other HTTP error code, if the method failed.
  • Body of the response is a JSON object (map) with the following fields:
    • status - a JSON map with a status of the method processing. It contains these subfields:
      • code - a numeric code of the operation status; it follows the concept of HTTP status codes (2XX, 4XX). Specific codes are described for each type of answer (or operation) (see below).
      • text - a text describing the status code
    • records - JSON array with the input records, each record enriched by field "recognition"
CLICK TO SHOW JSON RESULT

{
  "records": [
    {
      "_url": "__URL_PATH__",
      "_status": {
        "code": 200,
        "text": "OK",
        "request_id": "4629291a-98de-4e94-a346-ac2a6e17aedb"
      },
      "_id": "0064e43f-13fd-46c4-9027-acd125226179",
      "_width": 848,
      "_height": 1156,
      "recognition": [
        {
          "prob": 0.99928,
          "name": "Not energy label",
          "id": "ad76cee1-c8ac-4b0d-b9ea-c7147c8ebf03"
        },
        {
          "prob": 0.00072,
          "name": "Energy label",
          "id": "455203c3-ac79-45d5-a67c-475709587690"
        }
      ]
    }
  ],
  "status": {
    "code": 200,
    "text": "OK",
    "request_id": "4629291a-98de-4e94-a346-ac2a6e17aedb",
    "proc_id": "d9989195-8b80-4684-8412-9663569493a5"
  },
  "statistics": {
    "processing time": 0.189164400100708
  }
}

Recognition and Reading class endpoint: /v2/recognize_read_class

https://api.ximilar.com/energy-labels/v2/recognize_read_class

Given a list of image records, this method returns information if image is energy label or not, and if so returns also energy class.

Parameters:

  • records: list of photos to predict the tags for
    • must contain either of _url or _base64 field - see section image data for details

curl --url https://api.ximilar.com/energy-labels/v2/recognize_read_class
 --request POST 
 --header "Content-Type: application/json"
 --header "Authorization: Token __API_AUTH_TOKEN__" 
 --data '{
  "records": [
    {
      "_url": "__URL_PATH__"
    }
  ]
}'

Returns:

  • HTTP error code 2XX, if the method was OK and other HTTP error code, if the method failed.
  • Body of the response is a JSON object (map) with the following fields:
    • status - a JSON map with a status of the method processing. It contains these subfields:
      • code - a numeric code of the operation status; it follows the concept of HTTP status codes (2XX, 4XX). Specific codes are described for each type of answer (or operation) (see below).
      • text - a text describing the status code
    • records - JSON array with the input records, each record enriched by field "recognition" and "energy class"
CLICK TO SHOW JSON RESULT

{
  "records": [
    {
      "_url": "__URL_PATH__",
      "_status": {
        "code": 200,
        "text": "OK",
        "request_id": "43bcef0f-3020-4da9-8499-faa8e9df892f"
      },
      "_id": "01fec523-5b75-44f3-8e3c-e44cf7287753",
      "_width": 1200,
      "_height": 2527,
      "recognition": [
        {
          "prob": 0.99969,
          "name": "Energy label",
          "id": "455203c3-ac79-45d5-a67c-475709587690"
        },
        {
          "prob": 0.00031,
          "name": "Not energy label",
          "id": "ad76cee1-c8ac-4b0d-b9ea-c7147c8ebf03"
        }
      ],
      "energy class": [
        {
          "prob": 0.98846,
          "name": "A++",
          "id": "4f8999df-9760-4239-bbb7-e11897da20b0"
        },
        {
          "prob": 0.005,
          "name": "A+",
          "id": "ff0dfbf7-7b4f-497c-ad51-9e1d7bedd6cf"
        },
        {
          "prob": 0.00146,
          "name": "B",
          "id": "4d32dbe7-4e8d-4296-ac13-d5c26a9f77bb"
        },
        {
          "prob": 0.00135,
          "name": "A+++",
          "id": "6f03dda8-a026-4215-abaf-7c3ea5972fff"
        },
        {
          "prob": 0.00135,
          "name": "D",
          "id": "25f89fda-95d7-40cd-a1dd-c34877331718"
        },
        {
          "prob": 0.00132,
          "name": "A",
          "id": "0191c07f-b77a-4fcd-89d4-e05d3efbbaea"
        },
        {
          "prob": 0.00106,
          "name": "C",
          "id": "9681679c-8db8-4267-8087-0514b39481ca"
        }
      ]
    }
  ],
  "status": {
    "code": 200,
    "text": "OK",
    "request_id": "43bcef0f-3020-4da9-8499-faa8e9df892f",
    "proc_id": "bb25d752-c4df-49e7-ae30-c0b2bfcfe2c8"
  },
  "statistics": {
    "processing time": 0.48432469367980957
  }
}