Class Resource

Definition

This is an object representing a collection of images of concepts like identities or landmarks. The Class is a sub-resource of a Dataset.

ENDPOINTS

GET /v1/datasets/{DATASET_ID}/classes/

GET /v1/datasets/{DATASET_ID}/classes/{CLASS_ID}/

POST /v1/datasets/{DATASET_ID}/classes/

PUT /v1/datasets/{DATASET_ID}/classes/{CLASS_ID}/

DELETE /v1/datasets/{DATASET_ID}/classes/{CLASS_ID}/

Attributes

Top level attributes

Name	Type	Description
id	string	Global identifier to access the actual resource
reference	string	Custom ID (needs to be unique in the Dataset)
label	string	Name of the class
preview_image	Image object	First Image object that belongs to this class ("null" if class is empty)
time_created	string	Creation time of the class (ISO Time String)
time_updated	string	Modification time of the class (ISO Time String)
time_evaluated	dict	Evaluation time of the class per evaluator (ISO Time String)
active	boolean	Whether class is enabled for training or not. If not active, the class will be ignored during training.
notes	string	Description or notes of the class
expiration_date	string	Moment in time when the class should be deactivated (class will be ignored during training after this date) (ISO Time String)
level	number	Refers to the Dataset Creation of Lower Third Recognition (explanation will follow)
number_of_images	number	Number of images in this class
custom_fields	List of dict	Custom data can be bound to the class
type	string	The type of the dataset inherited from the dataset (e.g. "face", "landmark" or "logo")
evaluation_result	dict	Evaluation result of the class. See "Child attributes of evaluation_result"

Child attributes of evaluation_result

Coming soon

JSON Example

The following JSON snippet is showing a Class object.

{
  "id": "b01c397e-2cd7-424f-a77b-023083abd289",
  "reference": "0988e189-c826-41df-8c3a-6378b02753f1",
  "label": "Fritz Keller",
  "preview_image": {
    "id": "7e157415-eae9-4485-92ad-d09de17adc7d",
    "file_uri": "storage://t7r2deRbEW8SxZy3oHyX",
    "time_created": "2020-01-01 00:00:00.786000",
    "time_updated": "2020-01-01 00:00:00.786000",
    "active": true,
    "notes": "",
    "is_auto_generated": false,
    "evaluation_result": {}
  },
  "time_created": "2020-01-01 00:00:00.786000",
  "time_updated": "2020-01-01 00:00:00.786000",
  "time_evaluated": {"attribute_statistics": "2020-01-01 00:00:00.786000"},
  "number_of_images": 4,
  "active": true,
  "notes": "This is a text",
  "expiration_date": null,
  "custom_fields": [],
  "level": -1,
  "evaluation_result": {
    "attribute_statistics": {
      "head_pose": {
        "yaw_mean_std": [
          -19.7,
          1.56
        ],
        "pitch_mean_std": [
          1.4,
          0.95
        ]
      }
    }
  }
}