Query Search (Vector Projects)

Query Search allows users to search images in Vector Projects using more specific criteria than just image names. The fields and values entered in the query bar match the JSON format.

You can view all the images in a list view or a grid view. The grid view is the default view. To switch to the grid view, click the grid button next to the query bar.

The grid view allows you to see your images and their annotations in greater detail. It also shows you the names of the assigned Annotators and QAs, the image name and status, and the approval status.

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:

  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 Query Search was disabled then enabled, then you’ll have to sync the data again.

Display settings

In Display Settings, you can modify what you see in the Explore tab (grid view only).

Opacity

Modify the opacity of the instances by dragging the slider to the left or right.

Item information

  • Check the Information box to show the approval status, item name, and item status.
  • Check the Classes box to show the names of the classes.
  • Check the Attributes box to show the names of the attributes.

Class name

Check/Uncheck the box of a particular class to show/hide instances with that class.

Example queries

  • To search for items that have the In Progress status and are have Smart Prediction applied:

metadata(isPredicted = true AND status = InProgress )

  • To search for items that have instances that are polygons and are assigned to the classes car or pedestrian:

instance(type = polygon AND className IN [Car, Pedestrian] )

Fields and values

Instance and instance count

You can search instances (instance) and instance counts (instanceCount) by the following fields:

Field

Description

Value

type

Instance type

bbox polygon polyline point ellipse, cuboid rbbox tag

className

Class name

The value is a class name.

probability

Model training confidence score

Numeric value

attribute.name

Attribute name

The value is an attribute name.

attribute.groupName

Attribute group name

The value is an attribute group name.

error

Instance’s approval status

true false null

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

creationType

The instance’s creation type.

Manual Preannotation Prediction

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

createdAt

Date when the instance was created.

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

updatedAt

Date when the instance was last updated.

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

Metadata

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

Field

Description

Value

lastAction.email

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

The value is an email address.

lastAction.timestamp

Date when the item was last updated.

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

width

Item width

Numeric value

height

Item height

Numeric value

name

Item file name

The value is a name.

isPredicted

Information whether Smart Prediction was used on the item or not.

true false

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.

status

Item status

NotStarted InProgress QualityCheck Returned Completed Skipped

pinned

Item’s pin status

true false

approvalStatus

Item’s approval status

true false null

Comment

You can search comments (comment) by the following field:

Field

Description

Value

resolved

Information where the comment is resolved or not.

true false

Comment count

You can search the comment count (commentCount) by the following field:

Field

Description

Value

commentCount

The number of comments the item has.

Numeric value.

Tag

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 of items 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)

commentCount

The number of comments the item has.

ASC (ascending) DESC (descending)

instanceCount

The number of instances the item has.

ASC (ascending) DESC (descending)

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.

Download items

To download items from the selected items in the Query 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?