Canonical Tags
Unique entities described by a set of annotations
Canonical Tags are a way to reference a singular entity that is comprised of multiple fixed annotations. This is a useful abstraction when dealing with things like Airframes (Make, Model, Serial), People (First, Middle, Last), or Land (Section, Township, Range, QQ1, QQ2, etc). They are intended as a uniquely disambiguating abstraction for the multiple ways that a single entity can be expressed or written in a document.
Canonical Tags exist in two states. In their unattached state as CanonicalTag objects and as AttachedCanonicalTag object when describing a CanonicalTag that has been attached to an entire instrument or source file.
CanonicalTag Object
A canonical tag describes a unique entity defined by a type and an array of attributes
List the tags in a project
GET
https://api.annolab.ai/v1/project/{group_name}/{project_name}/tags
Returns a paginated list of tags in a project. Returns a limit of 10,000 tags per page/request.
Headers
Request Body
Create one or more Tags
POST
https://api.annolab.ai/v1/tag
Creates canonical tags. (Does not attach). If an identical canonical tag already exists, it does not create at duplicate.
Headers
Request Body
Edit a tag's values
POST
https://api.annolab.ai/v1/tag/{domain_entity_id}
Edits a CanonicalTag's typeName and/or attributes. Does not alter attachments.
Headers
Request Body
Delete a single tag by its domainEntityId
DELETE
https://api.annolab.ai/v1/tag/{domainEntityId}
Deletes a CanonicalTag. Delete will cascade and delete all related AttachedCanonicalTag objects as well.
Headers
Bulk delete tags by values
DELETE
https://api.annolab.ai/v1/tag
Deletes a CanonicalTag. Delete will cascade and delete all related AttachedCanonicalTag objects as well.
Headers
Request Body
AttachedCanonicalTag Object
An attached canonical tag object describes the attachment of a canonical tag to some Instrument or Source
Attach a tag to an instrument
POST
https://api.annolab.ai/v1/instrument-tag
Attaches a canonical tag to an instrument.
Headers
Request Body
Unattach a tag from an instrument
DELETE
https://api.annolab.ai/v1/instrument-tag
Removes a canonical tag attachment from an instrument
Headers
Request Body
(Alternate) Unattach a tag from an instrument
DELETE
https://api.annolab.ai/v1/instrument-tag/{instrument_id}/{domain_entity_id}
Alternative endpoint to unattach a tag from an instrument using the instrument id and domain entity id of the tag.
An instrument id is equivalent to the annotation id of a classification annotation.
Path Parameters
Headers
Attach a tag to a source
POST
https://api.annolab.ai/v1/source-tag
Attaches a canonical tag to a source.
Headers
Request Body
Unattach a tag from a source.
DELETE
https://api.annolab.ai/v1/source-tag
Removes a canonical tag attachment from a source
Headers
Request Body
(Alternate) Unattach a tag from a source
DELETE
https://api.annolab.ai/v1/source-tag/{source_id}/{domain_entity_id}
Alternative endpoint to unattach a tag from a source using the source id and domain entity id of the tag.
Path Parameters
Headers
Last updated