Query dataset

Run query

To run a query:

  1. Type a query in the input bar.
  2. Press the Enter key on the keyboard.

The displayed results are images that contain instances that match the query. For example, if you searched for instances of pedestrians that are annotated with Bounding Boxes, the search results are images that contain pedestrians that are annotated with Bounding Boxes.

Save query

To save a query:

  1. In the input field, click the hamburger button.
  2. Click Save Query.
  3. Type a query name.
  4. Click Save.

Edit query

To edit a saved query:

  1. In the top panel, click the bookmark button.
  2. Hover over the query you want to edit.
  3. Click the edit button.
  4. Edit the query name or query, or both.
  5. Click Save.

See saved queries list

To see a list of your saved queries, click the bookmark icon in the top panel.

📘

Viewers with the dataset’s public link can't see or save queries.

Delete query

Choose one of the following 2 methods to delete a query:

Method 1:

To delete a query:

  1. In the top panel, click the bookmark button.
  2. Hover over the query you want to delete.
  3. Click the delete button.

Method 2:

To delete a query:

  1. In the top panel, click the bookmark button.
  2. Hover over the query you want to delete.
  3. Click the edit button.
  4. Click Delete.

Permissions

Project contributors that have access to the explore feature can view, edit, and delete queries.

Query format

Single parameter
main field.field.subfield=parameter 1

Example
[email protected]

Array of parameters
main field.field.subfield IN [parameter 1, parameter 2…]

Example
metadata.lastAction.email IN [[email protected], [email protected]]

Array of parameters and more than one field
main field.field.subfield IN [parameter 1, parameter 2…] OR main field.field.subfield IN [parameter 1, parameter 2…]

Example
metadata.lastAction.email IN [[email protected], [email protected]] OR comments.resolved=true

Operators

Operator

Meaning

=

Equal to

!=

Not equal to

Greater than

<

Less than

=

Greater than or equal to

<=

Less than or equal to

()

Shows the hierarchy of queries

AND

Returns True if both statements are true

OR

Returns True if either statements are true

IN

Set of values to consider

Fields

The field names and values should be written in the JSON format.

Instances

Field

Value

instances.type

bbox, polygon, point, ellipse, cuboid, polyline, or rbbox.

instances.class.name

String. If there is no class assigned to an instance, then the parameter should be none.

instances.probability

Double

instances.pointLabels

Double

attributes.name

String

attributes.groupName

String

error

If the instance is approved, then it is false. If it is disapproved, then it is true. If there is no approval, then it is null. If the instance is neither approved nor disapproved, then the error field will not appear in JSON.

createdAt

Date in this format: YYYY-MM-DD.

createdBy.email

Email address

createdBy.role

Current SuperAnnotate role

creationType

manual or pre-annotation

updatedAt

Date in this format: YYYY-MM-DD.

updatedBy.email

Email address

updatedBy.role

Current SuperAnnotate role

count

Number of instances in the image

Metadata

Field

Value

lastAction.email

Email address

width

Width in pixels

height

Height in pixels

name

String

isPredicted

Boolean: true or false.

annotatorEmail

Email address

qaEmail

Email address

status

Image status

pinned

Boolean: true or false.

Comments

Field

Value

resolved

Boolean: true or false.

count

Number of comments

Tags

Field

Value

tags

Tag name

Folder

Field

Value

folder.name

Folder name in a string format


Did this page help you?