Query Search (Video Projects)
Query Search allows users 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?
Query Search 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:
- Go to the Explore tab.
- Click Sync data. If the dataset is synced, you can click Resync the dataset or skip to Step 3.
- Click the input bar.
- Choose the suggested fields and operators or type the query yourself.
- To run the query, press Enter on the keyboard.
If your permission to use Query Search was disabled then enabled, then you’ll have to sync the data again.
Example queries
- 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 )
Fields and values
Metadata
You can search the metadata (metadata
) by the following fields:
Field | Description | Value |
---|---|---|
| Item file name | The value is a name. |
| Item width | Numeric value |
| Item height | Numeric value |
| Item status |
|
| Item’s approval status |
|
| The assigned annotator’s email address. | The value is an email address. |
| The assigned QA’s email address. | The value is an email address. |
| Email address of the project contributor who made the last change to the item. | The value is an email address. |
| Date when the item was last updated. | The value is a date with this format YYYY-MM-DD. |
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 |
---|---|---|
| Instance type |
|
| Class name | The value is a class name. |
| Attribute name | The value is an attribute name. |
| Attribute group name | The value is an attribute group name. |
| Date when the instance was created. | The value is a date with this format YYYY-MM-DD. |
| Email address of the project contributor who created the instance. | The value is an email address. |
| Role of the project contributor who created the instance. |
|
| Date when the instance was last updated. | The value is a date with this format YYYY-MM-DD. |
| Email address of the project contributor who made the last change to the instance. | The value is an email address. |
| Role of the project contributor who made the last change to the instance. |
|
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
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 |
Sort list
You can sort the list in Explore by:
Field | Description | Value |
---|---|---|
| Item name |
|
| Item status |
|
| Date when the item was last updated. |
|
| Email address of the assigned QA. |
|
| Email address of the assigned annotator. |
|
| The duration of the instance. |
|
| The number of instances the item has. |
|
Metadata status order
The order is the following:
Not Started
,In Progress
,Quality Check
,Returned
,Complete
, andSkipped
.
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:
- Run a query.
- Select an item or multiple items.
- Click Change Status.
- Choose a status.
- Click Change.
Download items
To download items from the selected items in the Query Search results:
- Go to the Explore tab.
- Select the items you want to download.
- Click Download.
- 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.
Updated 7 days ago