Orm.collection

​

GetCollectionParams Objects

class GetCollectionParams(BaseDTO)

• top_level_folder_uuid - Optional UUID of the top-level folder to restrict results to. If omitted, Collections from all accessible top-level folders may be returned.
• collection_uuids - Optional list of Collection UUIDs to filter by. If provided, only Collections with these UUIDs are returned.
• page_token - Token for fetching the next page of results from a previous call.
• page_size - Maximum number of Collections to return in a single page.

​

CreateCollectionParams Objects

class CreateCollectionParams(BaseDTO)

• top_level_folder_uuid - Optional UUID of the top-level folder in which to create the Collection. If omitted, the default folder for the user or Project context may be used.

​

GetCollectionItemsParams Objects

class GetCollectionItemsParams(BaseDTO)

• include_client_metadata - Optionally include client metadata into the result of this query.
• page_token - Token for fetching the next page of Collection items from a previous call.
• page_size - Maximum number of items to return in a single page.

​

CreateCollectionPayload Objects

class CreateCollectionPayload(BaseDTO)

• name - Human-readable name of the Collection.
• description - Optional free-text description of the Collection and its intended use.

​

UpdateCollectionPayload Objects

class UpdateCollectionPayload(BaseDTO)

• name - New name for the Collection. If omitted or None, the name is not updated.
• description - New description for the Collection. If omitted or None, the description is not updated.

​

Collection Objects

class Collection(BaseDTO)

• uuid - Unique identifier of the Collection.
• top_level_folder_uuid - UUID of the top-level folder that owns this Collection.
• name - Human-readable name of the Collection.
• description - Optional free-text description of the Collection.
• created_at - Timestamp when the Collection was created.
• last_edited_at - Timestamp when the Collection was last modified.

​

GetCollectionsResponse Objects

class GetCollectionsResponse(BaseDTO)

• results - List of Collections matching the query parameters.

​

CollectionBulkItemRequest Objects

class CollectionBulkItemRequest(BaseDTO)

• item_uuids - UUIDs of items to include in the bulk operation. For example, to add or remove them from a Collection).

​

CollectionBulkItemResponse Objects

class CollectionBulkItemResponse(BaseDTO)

• failed_items - UUIDs of items for which the bulk operation failed.

​

CollectionBulkPresetRequest Objects

class CollectionBulkPresetRequest(BaseDTO)

• preset_uuid - UUID of the preset to apply to the Collection.

​

ProjectCollectionType Objects

class ProjectCollectionType(Enum)

• FRAME: The Collection groups frames or data items.
• LABEL: The Collection groups labels or annotations.

​

GetProjectCollectionParams Objects

class GetProjectCollectionParams(BaseDTO)

• project_hash - UUID of the project whose Collections should be listed.
• collection_uuids - Optional list of project Collection UUIDs to filter by.
• page_token - Token for fetching the next page of project Collections from a previous call.
• page_size - Maximum number of project Collections to return in a single page.

​

CreateProjectCollectionParams Objects

class CreateProjectCollectionParams(BaseDTO)

• project_hash - UUID of the Project in which to create the Collection.

​

CreateProjectCollectionPayload Objects

class CreateProjectCollectionPayload(CreateCollectionPayload)

• collection_type - Type of the Project Collection (frame-based or label-based).

​

ProjectCollection Objects

class ProjectCollection(BaseDTO)

• collection_uuid - UUID of the underlying Collection.
• name - Human-readable name of the Project Collection.
• description - Optional description of the Project Collection.
• created_at - Timestamp when the Project Collection was created.
• last_edited_at - Timestamp when the Project Collection was last modified.
• project_uuid - UUID of the project this Collection belongs to.
• collection_type - Type of the project Collection (frame-based or label-based).

​

GetProjectCollectionsResponse Objects

class GetProjectCollectionsResponse(BaseDTO)

• results - List of Project Collections matching the query parameters.

​

ProjectDataCollectionInstance Objects

class ProjectDataCollectionInstance(BaseDTO)

• frame - Frame index within the data item that is part of the Collection.

​

ProjectLabelCollectionInstance Objects

class ProjectLabelCollectionInstance(BaseDTO)

• frame - Frame index within the data item for which the annotation was created.
• annotation_id - Identifier of the annotation included in the Collection.

​

ProjectDataCollectionItemResponse Objects

class ProjectDataCollectionItemResponse(BaseDTO)

• label_row_metadata - Metadata describing the label row associated with the frames.
• instances - List of frame instances that are part of the Collection.

​

ProjectLabelCollectionItemResponse Objects

class ProjectLabelCollectionItemResponse(BaseDTO)

• label_row_metadata - Metadata describing the label row associated with the labels.
• instances - List of label instances that are part of the Collection.

​

ProjectDataCollectionItemRequest Objects

class ProjectDataCollectionItemRequest(BaseDTO)

• data_uuid - UUID (or string identifier) of the data item containing the frame.
• frame - Frame index within the data item to include in the Collection.

​

ProjectLabelCollectionItemRequest Objects

class ProjectLabelCollectionItemRequest(BaseDTO)

• data_uuid - UUID (or string identifier) of the data item containing the label.
• frame - Frame index within the data item for which the annotation was created.
• annotation_id - Identifier of the annotation to include in the Collection.

​

ProjectCollectionBulkItemRequest Objects

class ProjectCollectionBulkItemRequest(BaseDTO)

• items - List of data or label Collection item requests to include in the bulk operation.

​

ProjectCollectionBulkItemResponse Objects

class ProjectCollectionBulkItemResponse(BaseDTO)

• failed_items - Items for which the bulk operation failed. Each entry contains the original request that could not be processed successfully.