Resources

DatasetResource

Represents the metadata of a dataset.

Properties

Example

{
    "dataset_id": "dataset_id",
    "client_id": "client_id",
    "create_timestamp_millis": 1591397296799,
    "dataset_format": "json",
    "dataset_name": "dataset_name",
    "dataset_type": "3d",
    "files": [
        {
            "file_size": 18611529.0,
            "file_type": "application/zip",
            "resumable_upload_url": "https://www.googleapis.com/upload/storage/v1/b/url_for_file"
        }
    ],
    "labelling_mode": "frame_by_frame",
    "processing_status": "files_getting_labelled",
    "tags": [],
    "uploaded_files": [
        "json_data.zip"
    ],
    "processing_status_message": "Processing Json Files",
    "sensor_config": {
        "primary_sensor_id": "lidar",
        "sensors": {
            "lidar": {
                "content": "path_to_lidar",
                "sensor_type": "lidar",
                "calibration": {},
                "square_dimensions": [],
                "sensor_fusion": {
                    "camera_0": {
                        "view_matrix": [
                            [1, 0, 0, 0],
                            [0, 1, 0, 0],
                            [0, 0, 0, 1],
                            [0, 0, 1, 0]
                        ]
                    }
                }
            },
            "camera_0": {
                "content": "path_to_camera_0_img",
                "sensor_type": "camera",
                "extension": "jpg",
                "calibration": {},
                "square_dimensions": [],
                "sensor_fusion": {}
            }
        }
    },
    "folder_path": "clent_id/defaultproject/dataset_id",
    "frame_sizes": [51162, 51156, 51102, 51046, 51068, 51064, 51041, 50953, 51064, 51065, 51065],
    "pipeline_spec": [
        {
            "stage_id": "Labelling",
            "can_edit": true
        },
        {
            "stage_id": "QA",
            "can_edit": false
        }
    ],
    "current_stage": "Labelling",
    "current_stage_status": "ready",
    "pipeline_status_by_label_set_id": {
        "default": {
            "Labelling": {
                "done": 0,
                "failed": 0,
                "in_progress": 0,
                "ready": 0,
                "waiting": 0
            },
            "QA": {
                "done": 0,
                "failed": 0,
                "in_progress": 0,
                "ready": 0,
                "waiting": 0
            }
        }
    }
}

LabelResource

Represents the metadata of a Label.

Properties

Example

{
    "file_id": "000019.png",
    "label_category_id": "bus",
    "label_id": "bus:1",
    "label_type": "box",
    "attributes": {
        "attribute2": "attribute2_value1",
        "attribute1": "attribute_value1"
    },
    "box": [366, 87, 174, 116],
    "polygons": [
        [[338, 330], [460, 253], [567, 179], [773, 91], [862, 59]]
    ]
}

FileResource

Represents the metadata of a file.

Properties

Example

{
    "file_id": "000009.png",
}

NotificationResource

Represents a notification from Deepen AI. Currently, we support notification from Depeen AI after labelling of a dataset is complete. The url to notify should be configured at the dataset level.

Properties

Example

{
    "dataset_id": "testdataset",
    "notification_type": "DatasetLabellingComplete"
}

IssueResource

Represents the metadata of an Issue.

Properties

Example

{
    "issues": [
        {
            "author_email": "tupkarajinkya@gmail.com",
            "issue_title": "test Issue",
            "label_id": "test",
            "issue_creation_timestamp": {
                "$date": 1551194067161
            },
            "issue_description": "Issue Description",
            "issue_id": "6005288",
            "status": "to do",
            "label_category": "test",
            "region": {
                "extruded_polygon": {
                    "center_z": 1.0,
                    "xy_polygon": [
                        [1.0, 2.0],
                        [3.0, 4.0],
                        [5.0, 6.0]
                    ],
                    "height": 1.0
                }
            }

        }
    ]
}

TaskResource

Represents the metadata of a task.

Properties

Example

{
    "label_tasks": [
        {
            "task_id": "12345",
            "client_id": "test client",
            "dataset_id": "test dataset",
            "label_type": "box",
            "label_category_id": "car",
            "label_id": "car:1",
            "sensor_id": "lidar",
            "status": "ready",
            "stage_id": "labelling",
            "email": "test@gmail.com",
            "next_task_ids": [12345],
            "previous_task_ids": [12345678],
        }
    ]
}
{
    "file_tasks": [
        {
            "task_id": "12345",
            "client_id": "test client",
            "dataset_id": "test dataset",
            "file_id": "test file",
            "status": "ready",
            "stage_id": "labelling",
            "email": "test@gmail.com",
            "next_task_ids": [12345],
            "previous_task_ids": [12345678],     
        }
    ]
}

EmbeddedViewerDataResource

Represents the details of an embedded viewer.

Properties

Example

{
    "client_id": "testclient",
    "dataset_id": "testdataset",
    "jwt_token": "xtlz1235",
    "viewer_id": "1234567",
    "create_timestamp_millis": 100000000000,
    "title": "testviewer",
    "launching_frame_index": 1,
    "enable_camera_view": true,
    "expiry_timestamp_millis": 100000000000,
    "created_by": "test@gmail.com"
}

PolygonResource

Represents the metadata of an extruded polygon for IssueResource.

Properties

Example

{
  "extruded_polygon": {
    "center_z": 1.0,
    "xy_polygon": [
      [ 1.0, 2.0 ],
      [ 3.0, 4.0 ],
      [ 5.0, 6.0 ]
    ],
    "height": 1.0
  }
}

PipelineStageResource

Represents the details of a pipeline stage.

Properties

Example

// Some codejson
{
    "stage_id": "Labelling",
    "can_edit": "true"
}

LabellingProfileResource

Properties

Example

{
    "dataset_id" : "datset_id",
    "client_id" : "client_id",
    "created_email" : "test@deepen.ai",
    "created_timestamp_millis" : 1590037884298,
    "features" : {
        "box" : {
            "attributes" : {},
            "label_category_ids" : []
        },
        "lane" : {
            "attributes" : {},
            "label_category_ids" : []
        },
        "polygon" : {
            "attributes" : {},
            "label_category_ids" : []
        },
        "point" : {
            "attributes" : {},
            "label_category_ids" : []
        },
        "3d_bbox" : {
            "attributes" : {},
            "label_category_ids" : [
                "car"
            ],
            "label_category_default_dimensions" : {
                "car" : {
                    "width" : 2.25,
                    "height" : 2.25,
                    "length" : 2.25
                }
            }
        },
        "3d_polyline" : {
            "attributes" : {},
            "label_category_ids" : []
        },
        "3d_polygon" : {
            "attributes" : {},
            "label_category_ids" : []
        },
        "3d_point" : {
            "attributes" : {},
            "label_category_ids" : []
        },
        "3d_instance_point" : {
            "attributes" : {},
            "label_category_ids" : []
        }
    },
    "instructions" : {
        "text" : ""
    },
    "notification_url" : "",
    "pipeline_spec" : [
        {
            "stage_id" : "Labelling",
            "can_edit" : true
        },
        {
            "stage_id" : "QA",
            "can_edit" : false
        }
    ],
    "profile_id" : "profile_id",
    "profile_type" : "dataset",
    "updated_email" : "test@deepen.ai",
    "updated_timestamp_millis" : 1590038192070
}

TagResource

Represents the tag details for a dataset. A tag is basically any string that can be used to identify or categories the datasets. For backward compatibility with projects, we define a special tag starting with “project:”. This will enable you to group datasets by project and you can use these tags to filter the datasets. For api calls, a sample tags field will look like below.

Example

{
    "tags": ["project: testDeepenProject", "testtag"]
}

DatasetUserScopeResource

Properties

Example

{
    "email" : "user@deepen.ai",
    "scopes" : ["scope1", "scope2"]  
}

DatasetUserGroupScopeResource

Properties

Example

{
    "user_group_id" : "asdfrtfdv",
    "scopes" : ["scope1", "scope2"]
}

SensorConfigResource

Properties

Example

{
  "primary_sensor_id": "lidar",
  "sensors": {
    "lidar": {
      "content": "path_to_lidar",
      "sensor_type": "lidar",
      "sensor_fusion": {
        "camera_0": {
          "view_matrix": [
            [1, 0, 0, 0],
            [0, 1, 0, 0],
            [0, 0, 0, 1],
            [0, 0, 1, 0]
          ]
        }
      }
    },
    "camera_0": {
      "content": "path_to_camera_0_img",
      "sensor_type": "camera",
      "extension": "jpg"
    }
  }
}

SensorConfigSensorDetailsResource

Properties

Example

{
  "content": "path_to_lidar",
  "sensor_type": "lidar",
  "sensor_fusion": {
    "camera_0": {
      "view_matrix": [
        [1, 0, 0, 0],
        [0, 1, 0, 0],
        [0, 0, 0, 1],
        [0, 0, 1, 0]
      ]
    }
  }
}

UserGroupResource

Properties

Example

{
  "user_group_id": "user_group_id",
  "client_id": "client_id",
  "create_email": "user@deepen.ai",
  "create_timestamp_millis": 1595484956292,
  "emails": [
    "user1@deepen.ai",
    "user2@deepen.ai"
  ],
  "update_timestamp_millis": 1595484956292,
  "user_group_name": "TestUserGroup"
}

FeaturesResource

Properties

Example

{
  "box": {
    "attributes": {},
    "label_category_ids": [
      "Person",
      "VehicleOther",
      "Tank",
      "Gator",
      "PickupTruck"
    ]
  },
  "lane": {
    "attributes": {},
    "label_category_ids": []
  },
  "polygon": {
    "attributes": {},
    "label_category_ids": [
      "Car",
      "Road",
      "Person",
      "Truck",
      "Bicycle"
    ]
  },
  "point": {
    "attributes": {},
    "label_category_ids": []
  },
  "3d_bbox": {
    "attributes": {
      "direction": {
        "attribute_values_array": [
          "same",
          "opposite"
        ]
      },
      "occluded": {
        "attribute_values_array": [
          "yes",
          "no"
        ],
      }
    },
    "label_category_ids": [
      "Trailer",
      "LargeVehicle_Bus",
      "LargeVehicle_Truck",
      "Human",
      "Car",
    ],
    "label_category_default_dimensions": {
      "Trailer": {
        "width": 2.25,
        "height": 2.25,
        "length": 2.25
      },
      "LargeVehicle_Bus": {
        "width": 2.25,
        "height": 2.25,
        "length": 2.25
      },
      "Car": {
        "width": 2,
        "height": 1,
        "length": 4
      }
    },
    "label_category_attributes_config": {
      "Car": {
        "color": {
          "attribute_values_array": [
            "red",
            "black",
            "blue",
            "white",
            "grey",
            "other"
          ]
        }
      }
    }
  },
  "3d_polyline": {
    "attributes": {},
    "label_category_ids": []
  },
  "3d_polygon": {
    "attributes": {},
    "label_category_ids": []
  },
  "3d_point": {
    "attributes": {},
    "label_category_ids": [
      "Building",
      "Road",
      "Sidewalk",
      "Vegetation",
      "Pedestrian"
    ]
  },
  "3d_instance_point": {
    "attributes": {},
    "label_category_ids": []
  }
}

AttributesResource

Properties

Example

{
  "attribute_values_array": [
    "yes",
    "no"
  ]
}

AttributesConfigResource

Properties

Example

{
  "Car": {
    "color": {
      "attribute_values_array": [
        "red",
        "black",
        "blue",
        "white",
        "grey",
        "other"
      ]
    }
  }
}

DefaultDimensionResource

Properties

Example

{
  "width": 2.25,
  "height": 2.25,
  "length": 2.25
}

Last updated