Correct an analysis

Correct the value predicted by the AI.

This feature can be useful either for field workers to let them interact with the AI results or back office teams to help ultimately improve AI performances.

As the task correction is definitive, we however strongly recommend to limit accessibility to this feature to a defined set of users.

To correct the value of a specific task, an analysis must first have been carried out.

To better understand how this endpoint could be used in practice, please refer to our mobile application documentation.

All endpoints are described with the EU (Europe) server format. If your application runs on the US server, you will need to use the following format: https://api.{site-id}.customers.us1.deepomatic.com/v0.2/.

Every Deepomatic application is versioned. We recommend to not integrate any logic based on the tasks and task groups ids as those ids changes when a version is upgraded. You can instead use tasks and task groups names that are agnostic to version changes.

Correct the value of a specific task

PATCH https://api.{site-id}.customers.deepomatic.com/v0.2/work-orders/{id}/tasks/{task_id}/correction/

Path Parameters

Name	Type	Description
id*	string	Id of the work order owning the task to correct This id corresponds to the id returned in the create a work order API response.
task_id*	string	Task_id to correct

Headers

Name	Type	Description
Authorization*	string	Deepomatic API Key associated to your account.

Request Body

Name	Type	Description
corrected_value*	string	Corrected value Warning: it must be compatible with the task type (Boolean, Text, Number).

200: OK Everything worked as expected: the task is updated with the new value.

Response format

id - string : id of the task being corrected.

state - object : object containing in particular the task analyzed_value which is dependent on the task type (eg. if the type is "Boolean", then the value returned will be either True or False) and the corrected_value. The message displayed is linked to the corrected_value.

{
    "id": "db081122-b571-48d9-b19b-6f690be1e94e",
    "name": "equipment_after_intervention",
    "label": "Is it a photo of the equipment after intervention?",
    "type": "Boolean",
    "group_id": "6f15b52e-4717-4ec5-a8b2-bd58e7eec5ca",
    "group_name": "equipment-after-intervention"
    "state": {
        "id": "2052385d-ac0c-4080-b8e9-fa4814b5b407",
        "analyzed_value": true,
        "analyzed_date": "2023-05-29T17:43:12.260474Z",
        "corrected_value": false,
        "corrected_date": "2023-05-29T17:44:25.567482Z",
        "message": "Invalid photo",
        "color": "#e45d26",
        "is_conformity_validated": false
    }
}

403: Forbidden The API key doesn't have permissions to perform the request.

{"detail": "Authentication credentials not provided."}
OR
{"detail": "No user found for such apiKey."}

404: Not Found The requested resource (work order id) doesn't exist.

{"detail": "WorkOrder not found!"}

Request example

curl 'https://api.{site-id}.customers.deepomatic.com/v0.2/work-orders/{id}/tasks/{task_id}/correction/' \
    -X PATCH \
    -H 'Authorization: Token <your_api_key>' \       
    -H 'Content-Type: application/json' \       
    -d '{"corrected_value": false}'