Active Collections

​

Filter Presets

Filter presets are saved groups of filter criteria that you can reuse across Active.

​

Create Filter Preset

Create a Filter Preset based on raw JSON.

​

Update Filter Presets

​

List Filter Presets

List all Filter Presets in Active by name with their unique identifier.

​

Delete Presets

Use the following code template to delete a preset filter in Active.

# Import dependencies
from encord import EncordUserClient

SSH_PATH = "file-path-to-ssh-private-key"
PROJECT_ID = "<project-unique-id>"

# Preset ID to delete
PRESET_ID = "unique-preset-filter-id"  

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project = user_client.get_project(PROJECT_ID)

# Delete Preset Filter
project.delete_filter_preset(PRESET_ID)

​

View Preset JSON

This code outputs the filters that make up the Active filter preset in a JSON file format.

​

Collections

Active supports two types of Collections: Frame Collections and Label Collections.

Frame Collections are groups of frames (images and video frames) you selected by filtering, sorting, inspecting, and analyzing the data units in Active.

Label Collections are groups of labels, on your frames (images and video frames), that you selected by filtering, sorting, inspecting, and analyzing the labels on your data units in Active.

​

List Collections

List all Collections in an Active Project by name with their unique identifier.

​

List FRAME Collections

List all FRAME Collections in an Active Project by name with their unique identifier.

​

List LABEL Collections

List all LABEL Collections in an Active Project by name with their unique identifier.

​

Create Collection

Create a Collection with a meaningful name and description in a Folder.

​

Add Items to a Collection

You need the data hash of the data units in your Annotate Project to add the data units to an Active Collection.

​

Add Items to a Collection using Presets

The code to add items to a Frame Collection or a Label Collection is the same.

You can find the Preset ID for your preset in the Active UI.

​

Remove Items from a Collection

Remove items from a Frame or Label Collection.

​

Remove Items From a Collection using Presets

The code to remove items from a Frame Collection or a Label Collection is the same.

You can find the Preset ID for your preset in the Active UI.

​

List all Items in a Collection