Create a feature
Features define the tools and classifications used to annotate your data. To create features for use in an ontology, use theclient.create_feature_schema()
method.
Set aUIMode
for a feature
You can set a UIMode
for your classification, which works similarly like switching the dropdown
toggle inside the platform. The UIMode
has the following two options:
Classification.UIMode.SEARCHABLE
allows the feature to be searched inside a dropdown menu, equivalent to enabling the dropdown toggle.Classification.UIMode.HOTKEY
gives each answer option a dedicated hotkey, equivalent to disabling the dropdown toggle.
Set a likert scale
for a feature
You can set the parameter is_likert_scale
for your radio classification if all option values are integers.
Get a feature
You can get the feature schema by name or schema id. Only top-level feature schemas are supported.Update feature schema name
Updates the title/name of a feature schema. Only top-level feature schemas are supported.Delete or archive a feature in an ontology
Deletes or archives a feature schema from an ontology. If the feature schema is a root-level node with associated labels, it will be archived. If the feature schema is a nested node in the ontology without associated labels, it will be deleted. If the feature schema is a nested ontology node with associated labels, it will neither be deleted nor archived. To archive a feature means you can unarchive it later on and retrieve annotations made with this feature. If you delete a feature, the feature and its associated annotations cannot be recovered.Unarchive a feature in an ontology
Unarchives a feature schema node in an ontology. Only root-level feature schema nodes can be unarchived.Check whether a feature is archived
ReturnsTrue
if a feature schema is archived in the specified ontology, returns False
otherwise.