IR Result

Overview

For tasks submitted via Create Single Picture Task and Create Stitching Picture Task, if you include a callback_url in the request parameters, the callback_url will automatically receive notifications when the results of these tasks are ready or updated. These changes may be triggered by AI inference completion, manual updates, re-runs, etc.

Notes:

• You can use the update_time in the request body to identify if the data has been updated or not.
• The results of request body is the same as the results returned in the response body of Get IR Result.

Params

callback_url can include additional parameters to handle corresponding logic. Currently, the supported additional parameters are as follows:

Name	Type	Description	Required
row_sort	string	Sorting rule for rows: desc=rows are sorted from top to bottom, numbered n ~ 0; asc=rows are sorted from top to bottom, numbered 1 ~ n. Default is desc.	No
detail	bool	Whether detailed information is needed. If true, the response will include UPC, etc. Defaults to false.	No

Notes:

• For more information about row_sort and detail, please refer to: Get IR Result.
• This is an example of a callback_url: https://<your_domain>/callback?row_sort=desc&detail=true

Request Sample

Method

Request method is POST

Request Header

Content-Type: application/json
Content-Length: 2204
Connection: keep-alive
Content-Language: zh-CN
Nonce: c5ac7061fccab6bf3e254dcf98995b8c
Authorization：cbs:85206f97-2f4f-4b6e-8830-f3f4ec6fd6ae:RHHlRHs+Jkez/KmMzzK+zE6RRrmYCENwV4LsEUuO+4k=
Timestamp:1666764711

Request Body

{
  "status": "SUCCESS",
  "task_id": "b5fed073-d66a-451f-93c0-ea412d7543e8",
  "row_sort": "desc",
  "update_time": 1668478888000,
  "results": [
    {
      "image_url": "https://f-dev.clobotics.cn/4/0040ca4d85f5e5ef7354102f486ef843.jpg",
      "sku_list": [
        {
          "sku_id": "1047441",
          "sku_name": "Coke Original Sparkling Can 180 ml",
          "sku_count": 7,
          "brand": "Coke",
          "category": "Sparkling",
          "manufacturer": "Coca-Cola",
          "flavor": "",
          "sub_brand": "Original",
          "pack_type": "Can",
          "pack_size": "180",
          "sub_category": "",
          "unit": "ML",
          "area": 12.28,
          "total_width": 10.14,
          "upc": "3700050773"
        }
      ],
      "locations": [
        {
          "sku_id": "1044059",
          "bounding_box": {
            "x_min": 0.46711602807044983,
            "y_min": 0.7578532695770264,
            "x_max": 0.481109082698822,
            "y_max": 0.771846354007721
          },
          "position": {
            "index": 0,
            "row": 1,
            "col": 2,
            "stacking": 0
          },
          "box_id": 0,
          "box_type": 0,
          "linked_box_id": 0
        },
        {
          "sku_id": "1044059",
          "bounding_box": {
            "x_min": 0.5359848141670227,
            "y_min": 0.7501513361930847,
            "x_max": 0.5499778389930725,
            "y_max": 0.7641443610191345
          },
          "position": {
            "index": 0,
            "row": 1,
            "col": 3,
            "stacking": 0
          },
          "box_id": 0,
          "box_type": 0,
          "linked_box_id": 0
        }
      ],
      "qualities": [
        {
          "id": "23",
          "name": "test"
        }
      ],
      "metrics": [
        {
          "id": "3",
          "name": "Total facing",
          "value": "38"
        },
        {
          "id": "2",
          "name": "Total empty space",
          "value": "23"
        },
        {
          "id": "5",
          "name": "Total row",
          "value": "5"
        },
        {
          "id": "9",
          "name": "Total door",
          "value": "1"
        }
      ]
    }
  ]
}

Response Schema

For a detailed explanation of the schema, please refer to: Get IR Result#Response#Schema of data.