Everything Platform’s core capability is to analyze assets, such as images, and automatically generate annotations based on the detected concept instances.
An annotation represents structured information describing detected instances within an asset and associating them with the platform’s taxonomy concepts.
These annotations are used to describe and enrich the asset with relevant information, including the relationships between the instances and the corresponding concepts defined in the taxonomy.
An annotation object may be of different types:
POST api/annotation/v1/annotate-assetAnnotate Asset
This endpoint allows you to automatically annotate an asset by providing the asset ID and optionally taxonomy IDs to limit the scope of the annotation.
Request
Response
The response for this request is a list of Annotation objects.
In the common scenario of automatically annotating a picture, the response contains:
| Request Headers | |
| accessToken | <Acces Token> |
Body
{
"asset_id": "00000000-0000-4000-8000-000000000000",
"taxonomy_ids": [
"00000000-0000-4000-8000-000000000000",
"00000000-0000-4000-8000-000000000000",
"00000000-0000-4000-8000-000000000000",
"00000000-0000-4000-8000-000000000000"
]
}Example
Consider an asset representing an image of a black night sky with the moon visible.
The automatic annotation is initiated with the following API call, specifying the subset of the taxonomy concepts to look for in the source image
curl --location 'external/annotation/v1/annotate-asset' \
--header 'accessToken: ' \
--header 'Content-Type: application/json' \
--data '{
"asset_id": "a3599729-e0ab-4323-8edb-7da2e4f487ea",
"taxonomy_ids": [
"00000000-0000-1000-8000-000000000000", // "Celestial Body"
"00000000-0000-4000-8000-000000000000", // "Moon"
"00000000-0000-5000-8000-000000000000", // "Star"
"00000000-0000-6000-8000-000000000000", // "Sun"
"00000000-0000-7000-8000-000000000000" // "Comet"
]
}'When this image is processed by the Everything Platform, the following annotations might be generated:
{
"annotations": [
{
"annotation_id": "6f747cfc-a93f-4e6d-8dd0-08f1830a6df3",
"asset_id": "a3599729-e0ab-4323-8edb-7da2e4f487ea",
"annotation_type": "annotation_finding",
"findings": [
{
"id": "49b1bbda-1c84-42b8-b3b5-6a87946d4428",
"element_id": "afca7710-a868-49d3-970d-c8f517b38c7d",
"xc": 0.5,
"yc": 0.5,
"minSide": 0.2,
"maxSide": 0.4,
"theta": 0.61,
"confidence": 0.99
}
]
},
{
"annotation_id": "d4816397-9462-44c7-b0cc-ea7b7f36af50",
"asset_id": "49b1bbda-1c84-42b8-b3b5-6a87946d4428",
"annotation_type": "annotation_taxonomy",
"taxonomy_node_ids": [
"00000000-0000-1000-8000-000000000000", "Celestial Body"
"00000000-0000-4000-8000-000000000000" "Moon"
]
}
]
}To visually interpret the results generated by the Platform, the output can be understood as follows:
