Working with Metadata

Copy

Copied

import dtlpy as dl
project_name = 'project_name'
dataset_name = 'dataset_name'
# Get project and dataset
project = dl.projects.get(project_name=project_name)
dataset = project.datasets.get(dataset_name=dataset_name)

User Metadata

As a powerful tool to manage data based on your categories and information, you can add any keys and values to both the item’s and annotations’ user-metadata sections using the Dataloop SDK. Then, you can use your user-metadata for data filtering, sorting, etc.

Note
When adding metadata to the same item, the new metadata might overwrite existing metadata. To avoid overwriting a field or the entire metadata, use the list data type.

Metadata Data Types

Metadata is a dictionary attribute used with items, annotations, and other entities of the Dataloop system (task, recipe, and more). As such, it can be used with string, number, boolean, list or null types.

String

Copy

Copied

if 'user' not in item.metadata:
    item.metadata['user'] = dict()
item.metadata['user']['MyKey'] = 'MyValue'
annotation.metadata['user']['MyKey'] = 'MyValue'

Number

Copy

Copied

item.metadata['user']['MyKey'] = 3
annotation.metadata['user']['MyKey'] = 3

Boolean

Copy

Copied

item.metadata['user']['MyKey'] = True
annotation.metadata['user']['MyKey'] = True

Null – add metadata with no information

Copy

Copied

item.metadata['user']['MyKey'] = None
annotation.metadata['user']['MyKey'] = None

List

Copy

Copied

# add metadata of a list (can contain elements of different types).
item.metadata['user']['MyKey'] = ["A", 2, False]
annotation.metadata['user']['MyKey'] = ["A", 2, False]

Add new metadata to a list without losing existing data

Copy

Copied

item.metadata['user']['MyKey'].append(3)
item = item.update()
annotation.metadata['user']['MyKey'].append(3)
annotation = annotation.update()

Add metadata to an item's user metadata

Copy

Copied

local_path = r'C:/home/project/images/item.mimetype'
item_id = 'write-your-id-number'
# upload and claim item
item = dataset.items.upload(local_path=local_path)
# or get item
item = dataset.items.get(item_id=item_id)
# modify metadata
if 'user' not in item.metadata:
    item.metadata['user'] = dict()
item.metadata['user']['MyKey'] = 'MyValue'
# update and reclaim item
item = item.update()

Modify an existing user metadata field

Copy

Copied

local_path = r'C:/home/project/images/item.mimetype'
item_id = 'write-your-id-number'
# upload and claim item
item = dataset.items.upload(local_path=local_path)
# or get item
item = dataset.items.get(item_id=item_id)
# modify metadata
if 'user' not in item.metadata:
    item.metadata['user'] = dict()
item.metadata['user']['MyKey'] = 'MyValue'
# update and reclaim item
item = item.update()

Item in platform should have section 'user' in metadata with field 'MyKey' and value 'MyValue'.

Add metadata to annotations' user metadata

Copy

Copied

annotation_id = 'my-annotation-id'
# Get annotation
annotation = dl.annotations.get(annotation_id=annotation_id)
# modify metadata
annotation.metadata['user'] = dict()
annotation.metadata['user']['red'] = True
# update and reclaim annotation
annotation = annotation.update()

annotation in platform should have section 'user' in metadata with field 'red' and value True

Filter items by user metadata

1. Get your dataset

Copy

Copied

project_name = 'project_name'
dataset_name = 'dataset_name'
project = dl.projects.get(project_name=project_name)
dataset = project.datasets.get(dataset_name=dataset_name)

2. Add metadata to an item

You can also add metadata to filtered items

Copy

Copied

local_path = r'C:/home/project/images/item.mimetype'
item_id = 'write-your-id-number'
# upload and claim item
item = dataset.items.upload(local_path=local_path)
# or get item
item = dataset.items.get(item_id=item_id)
# modify metadata
if 'user' not in item.metadata:
    item.metadata['user'] = dict()
item.metadata['user']['MyKey'] = 'MyValue'
# update and reclaim item
item = item.update()

3. Create a filter

Copy

Copied

filters = dl.Filters()
# set resource - optional - default is item
filters.resource = dl.FiltersResource.ITEM

4. Filter by your written key

Copy

Copied

filters.add(field='metadata.user.Key', values='Value')

5. Get filtered items

Copy

Copied

pages = dataset.items.list(filters=filters)
# Go over all item and print the properties
for page in pages:
    for item in page:
        item.print()