Image Resource

Definition

This is an object representing an actual image of a concept like a identity or landmark. The Image is a sub-resource of a Class.

ENDPOINTS

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

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

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

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

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

Attributes

Top level attributes

Name	Type	Description
id	string	Global identifier to access the actual resource
file_uri	string	Actual image file as DeepVA Storage URL
time_created	string	Creation time of the image (ISO Time String)
time_updated	string	Modification time of the image (ISO Time String)
active	boolean	Whether image is enabled for training or not. If not active, the image will be ignored during training.
notes	string	Notes of the image
is_auto_generated	boolean	Is set to true if image was generated during Dataset Creation via Lower Third Recognition
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 Image object.

{
  "id": "0a98ca4b-6c88-42e8-99d6-24d273f21e23",
  "file_uri": "storage://V4Ic75h6RYqKXK9TkkDw",
  "time_created": "2020-01-01 00:00:00.786000",
  "time_updated": "2020-01-01 00:00:00.786000",
  "active": true,
  "notes": "This is a text",
  "is_auto_generated": false,
  "evaluation_result": {
    "face_attributes": {
      "emotion": "Calm",
      "smile": false,
      "eyeglasses": false,
      "sunglasses": false,
      "eyesopen": true,
      "mouthopen": false,
      "beard": false,
      "mustache": false,
      "roll": -15,
      "yaw": 35.97,
      "pitch": -8.71
    },
    "face_clustering": "cluster_main"
  }
}