queries

When you’re in the Explore tab, you'll see a query search bar above your items. This bar takes JSON queries that'll allow you to search for items in your project that match any given criteria. To see information about queries regarding LLMs and GenAI projects, read here.

Here are some example queries you can try out:

FunctionQuery
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])
To search for items that have unresolved comments.comment(resolved = false)
To search for items that contain Bounding Boxes.instance(type = bbox)
To search for items that contain instances with the class Car.instance(className = Car)
To search for items that have the Completed status and are located in Folder1.metadata(status = Completed) AND folder = Folder1
To search for items that contain more than 3 instances with the class Car and the attribute Black.instanceCount(className = Car AND attributes.name = Black) > 3
To search for pinned items.metadata(pinned = true)

Operators

You'll need to use operators to define your queries and values.

OperatorDescription
=Equal.
!=Not equal.
>Greater than.
<Less than.
>=Greater than or equal to.
<=Less than or equal to.
()Query parentheses.
[]Array.
ANDReturns True if both statements are true.
ORReturns True if either statement is true.
INSet of values to consider.
NOT INSet of values to not consider.
CONTAINSUsed to search for a substring and returns the results containing that substring. All text queries made with this operator are case-insensitive.

📘

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

Instance

These parameters can be found under the instance field.

ParameterValueTextImageVideo
typebbox, polygon, polyline, point, ellipse, cuboid, rbbox, tag and relationship.
classNameThe value is a class's name.
probabilityNumeric value.
attribute.nameThe value is an attribute's name.
attribute.groupNameThe value is an attribute group's name.
errortrue, false, or null.
createdBy.emailThe value is an email address.
createdBy.roleAnnotator, QA or Admin.
creationTypeManual, Preannotation or Prediction.
updatedBy.emailThe value is an email address.
updatedBy.roleAnnotator, QA or Admin.
createdAtThe value is a date with this format: YYYY-MM-DD.
updatedAtThe value is a date with this format: YYYY-MM-DD.
measure.bboxarea, width and height.

🚧

About class names

If the class name contains an operator (and, or, in, not in, contains), the query will handle them as operators, not as words in class names. For example, if the class name is Cars and pedestrians, the query will handle the word cars and the word pedestrians separately. Instead, you can use symbols, such as underscores, to separate the words. So Cars and pedestrians would be changed to cars_and_pedestrians.

Metadata

These parameters can be found under the metadata field.

ParameterValueTextImageVideo
statusNotStarted, InProgress, QualityCheck, Returned, Completed, and Skipped.
approvalStatustrue, false and null.
lastAction.emailThe value is an email address.
lastAction.timestampThe value is a date with this format: YYYY-MM-DD.
widthNumeric value.
heightNumeric value.
nameThe value is the item's name.
isPredictedtrue and false.
annotatorEmailThe value is an email address. Use null for unassigned items.
qaEmailThe value is an email address. Use null for unassigned items.
pinnedtrue and false.
priorityNumeric value.

Other fields

FieldParameterValueTextImageVideo
commentresolvedtrue and false.
commentCount-Numeric value.
tag-tag [operator] [tag name]
folderName-The value is the folder's name.
folderStatus-The value is the folder's status.
subsetName-The value is the subset’s name.
freeText-freeText [operator] text
random-Numeric value.
customMetadata-Depending on the field type. Please check this page for more information.

Generate query

First, make sure that your dataset is synced. You can do so by pressing the Sync data button.

To generate a query:

  1. In the Explore tab, click the query input bar.
  2. Choose the suggested fields and operators or type the query yourself.
  3. To run the query, press Enter on the keyboard.

Save query

To save a query:

  1. Type a query in the query bar.
  2. Click on the star on the right side 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.

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.

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 delete.
  3. Select Delete.