Explore dataset (Video Projects)

Go to Explore to search videos in Video Projects using more specific criteria than just video names. The fields and values entered in the query bar match the JSON format.

How does it work?

Explore works in two ways: you can type the queries yourself or use autosuggestions. Autosuggestion makes it easier for you to generate the queries.

To generate a query:

  1. Go to the Explore tab.
  2. Click Sync data. If the dataset is synced, you can click Resync the dataset or skip to Step 3.
  3. Click the input bar.
  4. Choose the suggested fields and operators or type the query yourself.
  5. To run the query, press Enter on the keyboard.

📘

If your permission to use Explore was disabled and then enabled, then you’ll have to sync the data again.

Example queries

Function

Query

To search for items that have the In Progress status and are where assigned to the annotator whose email is [email protected]

metadata(status = InProgress AND annotatorEmail = [email protected] )

To search for items that have instances that are bounding boxes and are assigned to the class pedestrian

instance(type = bbox AND className = Pedestrian )

To search for items that contain instances with the class Car

instance(className = Car )

To search for items that have the attribute Red

instance(attributes.name = Red )

To search for items that have more than 3 keyframes with the class Frisbee

keyframeCount(className = Frisbee ) > 3

To search for items that contain instances with a duration of more than 7 seconds

annotationDuration > 7

To search for items that have the annotation status QualityCheck

metadata(status = QualityCheck )

To search for items that contain Bounding Boxes

instance(type = bbox )

To search for items that have the Completed status and are located in folder1

metadata(status = Completed ) AND folder = folder1

📘

Click on the query bar to see the last 3 unique queries.

Fields and values

Metadata

You can search the metadata (metadata) by the following fields:

Field

Description

Value

name

Item file name

The value is a name.

width

Item width

Numeric value

height

Item height

Numeric value

status

Item status

NotStarted InProgress QualityCheck Returned Completed Skipped

approvalStatus

Item’s approval status

true false null

annotatorEmail

The assigned annotator’s email address.

The value is an email address.

qaEmail

The assigned QA’s email address.

The value is an email address.

lastAction.email

Email address of the project contributor who made the last change to the item.

The value is an email address.

timestamp

Date when the item was last updated.

The value is a date with this format YYYY-MM-DD.

duration

Video duration

Numeric value (in seconds)

priority

Priority score

Numeric value

Instance, instance count, keyframe count, and annotation duration

You can search instances (instance), instance count (instanceCount), keyframe count (keyframeCount), and the annotation duration in seconds (annotationDuration) by the following fields:

Field

Description

Value

type

Instance type

bbox event

className

Class name

The value is a class name.

attributes.name

Attribute name

The value is an attribute name.

attributes.groupName

Attribute group name

The value is an attribute group name.

createdAt

Date when the instance was created.

The value is a date with this format YYYY-MM-DD.

createdBy.email

Email address of the project contributor who created the instance.

The value is an email address.

createdBy.role

Role of the project contributor who created the instance.

Annotator QA Admin

updatedAt

Date when the instance was last updated.

The value is a date with this format YYYY-MM-DD.

updatedBy.email

Email address of the project contributor who made the last change to the instance.

The value is an email address.

updatedBy.role

Role of the project contributor who made the last change to the instance.

Annotator QA Admin

Tags

You can search tags (tag) this way:

tag [insert operator here] [insert tag name here]

Example: tag = nature

Folder

You can search folders (folder) this way:

folder [insert operator here] root

Example: folder = root

Custom metadata

You can search by custom metadata (customMetadata) this way:

Field

Description

Value

customMetadata

Custom metadata

Depending on the field type. Please check this page for more information.

Operators

Operator

Description

=

Equal

!=

Not equal

Greater than

<

Less than

=

Greater than or equal to

<=

Less than or equal to

()

Query parentheses

[]

Array

AND

Returns True if both statements are true

OR

Returns True if either statements are true

IN

Set of values to consider

NOT IN

Set of values to not consider

CONTAINS

Used to search for a substring and returns the results containing that substring

📘

When the attribute has a numeric type, the following operators will be supported for attributes.name: > < =< !=

Sort list

You can sort the list in Explore by:

Field

Description

Value

metadata.name

Item name

ASC (ascending) DESC (descending)

metadata.status

Item status

ASC (ascending) DESC (descending)

metadata.lastAction.date

Date when the item was last updated.

ASC (ascending) DESC (descending)

metadata.qaEmail

Email address of the assigned QA.

ASC (ascending) DESC (descending)

metadata.annotatorEmail

Email address of the assigned annotator.

ASC (ascending) DESC (descending)

metadata.annotationDuration

The duration of the instance.

ASC (ascending) DESC (descending)

instanceCount

The number of instances the item has.

ASC (ascending) DESC (descending)

📘

Metadata status order

The order is the following: Not Started, In Progress, Quality Check, Returned, Complete, and Skipped.

Save query

To save a query:

  1. Type a query in the query bar.
  2. Click on the star at the right edge of the query bar.
  3. In the popup, type a query name.
  4. Click Save.

📘

  • The maximum number of characters for a query is 60.
  • You can save up to 50 queries.
  • If you’ve successfully saved the query, you'll see this message: “You’ve successfully saved the query.”
  • If the query can’t be saved, you'll see this message: “Oops! Something went wrong.”

Rename query

To rename a query:

  1. Click on the star in the query bar.
  2. Click the three dots next to the query you want to rename.
  3. Select Rename.
  4. Type a new query name.
  5. Click Rename.

📘

If you’ve successfully renamed the query, you'll see this message: “You’ve successfully renamed the query.”
If the query can’t be renamed, you'll see this message: “Oops! Something went wrong.”

Delete query

To delete a query:

  1. Click on the star in the query bar.
  2. Click the three dots next to the query you want to rename.
  3. Select Delete.

📘

  • If you’ve successfully deleted the query, you'll see this message: “You’ve successfully deleted the query.”
  • If the query can’t be deleted, you'll see this message: “Oops! Something went wrong.”

Subsets

Add items to a subset

To add an item or multiple items to a subset:

  1. In Explore, select an item or multiple items.
  2. Click Add to subset.
  3. Choose an existing subset or create a new one. To create a new subset, type a non-existing name in the search bar and click Create subset.
  4. Click Save.

View subset

To view all your subsets, click on Display Settings next to the search bar. You’ll find all your subsets under Subsets.

Delete a subset

To delete a subset:

  1. Find the subset you want to delete under Subsets in the left panel.
  2. Click on the three dots > Delete.
  3. In the popup, select Delete.

Delete items from a subset

To delete items from a subset:

  1. Select items in a subset.
  2. Click Remove From Subset.

📘

You can perform the following bulk actions in a subset: change the status of items, approve/disapprove items, set priority scores, and download a dataset.

Change status in bulk

You can change the status of the item(s) that appear as a result of your query.

To change the status of an item or multiple items:

  1. Run a query.
  2. Select an item or multiple items.
  3. Click Change Status.
  4. Choose a status.
  5. Click Change.

Approve/Disapprove items in bulk

To change the approval status of an item or multiple items:

  1. Select one item or multiple items.
  2. Click the Approve/Disapprove items button in the menu at the bottom.
  3. Choose the status: Approve, Disapprove, or None.
  4. Click Change.

Set priority scores in bulk

To set the priority scores in bulk:

  1. Select multiple items.
  2. Click Priority scores.
  3. Choose a value.
  4. Click Set.

🚧

Annotators will receive the items with a higher priority score first.

Download items

To download items from the selected items in the search results:

  1. Go to the Explore tab.
  2. Select the items you want to download.
  3. Click Download.
  4. When the download is ready, you’ll be redirected to the Download page. Find your dataset and click the download button to download it.

If you want to send the dataset to someone, click the link button and copy the link. Anyone who has the link can access the data.

📘

Download limitations

A user can generate up to 50 downloads per day and per project. Only up to 50 downloads can be available. If you have 50 downloads in a project and create a new one, the oldest download will be deleted to make space for the new project.

The download package contains:

  • A folder that contains the classes in JSON files.
  • A folder that contains the annotations in JSON files.

If some of the items are inside folders, then their corresponding files will be located inside folders in the download package as well. The folder structure is kept the same.


Did this page help you?