clientMetadata
), which is the metadata associated with individual data units. This is distinct from videoMetadata
that is used to specify video parameters when using Strict client-only access. It is also distinct from patient metadata in DICOM files.clientMetadata
) is accessed by specifying the dataset using the <dataset_hash>. All Projects that have the specified Dataset attached contain custom metadata.
video.description
, while team B could use audio.description
. Another example could be TeamName.MetadataKey
. This approach maintains clarity and avoids key collisions across departments.varchar
as a versatile default. Scalar Key | Description | Display Benefits |
---|---|---|
boolean | Binary data type with values “true” or “false”. | Filtering by binary values |
datetime | ISO 8601 formatted date and time. | Filtering by time and date |
number | Numeric data type supporting float values. | Filtering by numeric values |
uuid | UUIDv4 formatted unique identifier for a data unit. | Filtering by customer specified unique identifier |
varchar | Textual data type. Formally string . string can be used as an alias for varchar , but we STRONGLY RECOMMEND that you use varchar . | Filtering by string. |
text | Text data with unlimited length (example: transcripts for audio). Formally long_string . long_string can be used as an alias for text , but we STRONGLY RECOMMEND that you use text . | Storing and filtering large amounts of text. |
add_enum
and add_enum_options
to add an enum and enum options to your metadata schema.
Key | Description | Display Benefits |
---|---|---|
enum | Enumerated type with predefined set of values. | Facilitates categorical filtering and data validation |
add_embedding
to add an embedding to your metadata schema.
Key | Description | Display Benefits |
---|---|---|
embedding | 1 to 4096 for Index. 1 to 2000 for Active. | Filtering by embeddings, similarity search, 2D scatter plot visualization (Coming Soon) |
Deprecated
ENUM Name | String Representation | Description | Display Benefits |
---|---|---|---|
NUMBER | number | Numeric data type supporting float values | Filtering by numeric values |
STRING | string | Textual data type | Filtering by string |
BOOLEAN | boolean | Binary data type with values “true” or “false” | Filtering by binary values |
DATETIME | datetime | ISO 8601 formatted date and time | Filtering by time and date |
ENUM | enum | Enumerated type with predefined set of values | Facilitates categorical filtering and data validation |
EMBEDDING | embedding | 1 to 4096 for Index. 1 to 2000 for Active. | Filtering by embeddings, similarity search, 2D scatter plot visualization (Coming Soon) |
LONG_STRING | long_string | Text data with unlimited length (example: transcripts for audio) | Storing and filtering large amounts of text |
Deprecated
Deprecated
.set_scalar()
method. The example below shows how to update the data type for multiple metadata fields.
Fruit
.
Fruit
.
keyframes
keyframes
is reserved for use with frames of interest in videos. Specifying keyframes
on specific frames ensures that those frames are imported into Index and Active. That means frames specified using keyframes
are available to filter your frames and for calculating embeddings on your data.
keyframes
while importing your videos or after you import your videos.
keyframes
to specific data units in a folderkeyframes
on specific videos in Index. This code DOES NOT OVERWRITE all existing custom metadata on a data unit. It does overwrite custom metadata with existing values and adds new custom metadata to the data unit.
print
command after importing or updating your custom metadata.bundle
allows you to update up to 1000 label rows at a time.
bundle
allows you to update up to 1000 label rows at a time.
clientMetadata
) to specific data units in the Dataset.
<data unit number>
by reading all metadata in the Dataset. The sample code provided prints all <data unit number
s.clientMetadata
) to all data units in a datasetclientMetadata
) to each data unit in the specified dataset. The code prints the custom metadata along with the data units index within the dataset, so that you can verify that the custom metadata was set correctly.