A classification links an existing Machine Learning class to an element, with a confidence score.
It can also be used for
manual classification by human annotators.
Pending, when created by a workflow,
Validatedwhen approved by a human annotator,
Rejectedwhen invalidated by a human annotator.
confidencescore, set between 0.0 and 1.0 (percentage). It defaults to 1.0 when the classification is created by a human (we always trust human annotators)
Trueon the classification, when it judges that the confidence score is high enough (that score would be dependent on tools, models and context).
Best classes represents significant classifications for an element. They are used by the web interface and API endpoints to filter the most important elements.
A classification is known has a best class:
high_confidenceflag is set by a Machine Learning workflow (and has not been rejected)
When browsing elements, you can select a specific class to view which elements have that class with a high confidence, or already validated. You can also filter all elements that have any best class, or no best class at all.
When viewing the details of a single element, the panel on the right side has a Classifications section where you can:
You cannot create a new Machine Learning class from this interface, but you can apply an existing one (provided it's not already applied)
If a Machine Learning worker produces a classification with a high confidence (known high score), a gold medal icon will appear next to the class name:
These endpoints are the most useful to handle Element classifications:
In order to retrieve the best classifications within a list of elements, you can use
with_best_classes=true query paramenter on these endpoints: