Query Search (Text Project)

Query Search allows users to search documents in Text Projects using more specific criteria than just file 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:

  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.

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 are in progress and have at least one instance that has the tag Negative:

instance(type = tag AND className = Negative ) AND metadata(status = InProgress )

Fields and values

Metadata

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

Field

Description

Value

status

Item status

NotStarted InProgress QualityCheck Returned Completed Skipped

lastAction.email

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

The value is an email address.

name

Item file name

The value is a name.

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.

Instance and instance count

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

Field

Description

Value

type

Instance type

entity tag

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.

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

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.

Folder

You can search folders (folder) this way:

folder [insert operator here] root

Example: folder = root

Free text

You can search free texts (freeText) this way:

freeText [insert operator here] text

Example: freeText = Product descriptions.

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 Data 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)

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.

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.

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?