Index Collections

​

Filter Presets

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

​

Create Filter Preset

Create a Filter Preset based on raw JSON.

​

Update Filter Presets

​

Delete Filter Presets

# Import dependencies
from encord import EncordUserClient

# Define constants
SSH_PATH = "file-path-to-ssh-private-key"

# Preset ID to add to the collection
PRESET_ID = "unique-preset-filter-id"  

# Initialize the user client using the SSH private key
user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Delete the preset by ID
user_client.delete_preset(PRESET_ID)

​

List Filter Presets

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

​

List Filters in Filter Preset

This code lists the filters that make up the filter preset into a JSON file format.

Filters are of the following types:

• Global filters: Global filters can apply to the data in any top-level Folder. Examples: Data type, Storage Location, Quality Metrics.

• Local filters: Local filters can apply ONLY to specific top-level Folders. Examples: Data title, File ID, Collection.

Returned results are a combination of Global and Local filters. While Global filters provide information about filter, Local filters provide a raw filter ID.

​

Add Filter Preset Contents to Collection

Adds all storage items that match the criteria specified by a filter preset to a Collection.

​

Remove Filter Preset Contents from Collection

Removes all storage items that match the criteria specified by a filter preset from a Collection.

​

Collections

Collections are groups of data units you selected by filtering, sorting, inspecting, and analysing the data units in Index.

​

List Collections

List all Collections in Index by name with their unique identifier.

​

Create Collection

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

​

Add Storage Items to a Collection using UUIDs

Add storage items to a Collection using the UUID of the storage items.

​

Remove Storage Items from a Collection using UUIDs

Remove storage items from a Collection using UUIDs.

​

List all Storage Items in a Collection

Lists all storage items in a Collection