Tagging System

Tags are simple key-value labels you can attach to any file record.

All tags consist of a name (the key, e.g., language) and a value (e.g., eng).

1. Public vs. Private Tags

By default, all tags you add are Private—visible only to you.

Adding a Public Tag

CLIPython

# This creates a PRIVATE record by default
dorsal file push "C:\data\annual_report.pdf"

from dorsal import LocalFile

lf = LocalFile("C:\data\annual_report.pdf")

lf.add

Your private tags can be one of two types:

Custom Tags: You have the freedom to use any name you want (e.g., project_status, client_id). These tags are not validated against a central list, giving you complete flexibility for your own organizational needs.
Simple Labels: A special type of private tag used for status tracking (e.g. "urgent", "todo"). In the CLI, these are referred to as "Labels". They always use the tag name label.
Supported Tags: You can also use our official tag names (like language or version). When you do, the system validates your input, ensuring your private metadata stays clean and accurate.

Public Tags

To add a Public tag that everyone can see, you must use the --public flag (in the CLI) or the dedicated Python method.

Public tags are visible to anyone who can view the file record. To ensure data quality and consistency across the platform, they are strictly controlled and must use a name and value from the official "Supported Tags" list.

2. Supported Tags

This is the official list of tags the system recognizes. When you use these tag names (either publicly or privately), the value you provide will be validated against the rules described here.

Tag Name	Value Type	Description	Availability
`corrupted`	Boolean	File is corrupted and cannot be opened.	Public & Private
`password`	String	Password needed to unlock the file.	Public & Private
`locked`	Boolean	File is locked or protected.	Public & Private
`encrypted`	Boolean	File is encrypted.	Public & Private
`compressed`	Boolean	File is compressed (e.g., a .zip).	Public & Private
`language`	String	A valid 3-letter language code.	Public & Private
`country`	String	A valid ISO 3166 country name or code.	Public Only
`arxiv_id`	String	A unique arXiv preprint identifier.	Public Only
`archived`	Boolean	File is archived (e.g., for reference).	Private Only
`confidential`	Boolean	File is confidential.	Private Only
`draft`	Boolean	File is a draft version.	Private Only
`final`	Boolean	File is the final version.	Private Only
`version`	String	A version string (e.g., "1.2.0").	Private Only
`genre`	String	The genre of the content.	Private Only
`label`	String	A simple status label (e.g. "urgent").	Private Only