Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encord.com/llms.txt

Use this file to discover all available pages before exploring further.

​
FilterPreset Objects

class FilterPreset()
Represents preset in Index. Preset is a group of filters persisted which can be reused for faster data curation.

​
uuid

@property
def uuid() -> UUID
Get the preset uuid (i.e. the preset ID). Returns:
  • str - The preset uuid.

​
name

@property
def name() -> str
Get the preset name Returns:
  • str - The preset name.

​
description

@property
def description() -> Optional[str]
Get the preset description Returns:
  • Optional[str] - The preset description.

​
created_at

@property
def created_at() -> Optional[datetime]
Get the preset creation timestamp Returns:
  • Optional[datetime] - The preset creation timestamp.

​
last_updated_at

@property
def last_updated_at() -> Optional[datetime]
Get the preset last update timestamp Returns:
  • Optional[datetime] - The preset last update timestamp.

​
update_preset

def update_preset(name: Optional[str] = None,
                  description: Optional[str] = None,
                  filter_preset_json: Optional[dict] = None) -> None
Update the preset’s definition. Arguments:
  • name Optional[str] - The new name for the preset.
  • description Optional[str] - The new description for the preset.
  • filter_preset_json Optional[dict] - The new filters for the preset in their raw json format.

​
ProjectFilterPreset Objects

class ProjectFilterPreset()
Represents Active filter presets.

​
uuid

@property
def uuid() -> UUID
Get the filter preset unique identifier (UUID). Returns:
  • UUID - The filter preset UUID.

​
name

@property
def name() -> str
Get the filter preset name. Returns:
  • str - The collection name.

​
created_at

@property
def created_at() -> Optional[datetime]
Get the filter preset creation timestamp. Returns:
  • Optional[datetime] - The timestamp when the filter preset was created, or None if not available.

​
updated_at

@property
def updated_at() -> Optional[datetime]
Get the filter preset last edit timestamp. Returns:
  • Optional[datetime] - The timestamp when the filter preset was last edited, or None if not available.

​
project_hash

@property
def project_hash() -> UUID
Get the project hash of the filter preset. Returns:
  • UUID - The project hash of the filter preset.