Explore dataset (Text Project)

Go to Explore 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?

Explore 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. If the data isn't synced, click Sync data. If the dataset is synced, 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 Explore was disabled and then enabled, then you’ll have to sync the data again.
  • If you're experiencing issues with the dataset, you can click Resync the dataset.

Example queries

FunctionQuery
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 are in progress and have at least one instance that has the tag Negativeinstance(type = tag AND className = Negative ) AND metadata(status = InProgress )
To search for items that have the annotation status QualityCheckmetadata(status = QualityCheck )
To search for items that contain tagsinstance(type = tag)
To search for items that contain more than 4 tagsinstanceCount(type = tag ) > 4
To search for items that contain the following text: Reviews from the websitefreeText = Reviews from the website
To search for items whose assigned annotator has the following email address: [email protected]metadata(annotatorEmail = [email protected])
To search for items that don't have the NotStarted and InProgress annotation statusesmetadata(status NOT IN [NotStarted, InProgress])
To search for items that have the Completed and Skipped annotation statuses and are located in Folder 1metadata(status IN [Completed, Skipped]) AND folder = Folder 1)

📘

Click on the query bar to see the last 3 unique queries.

Fields and values

Metadata

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

FieldDescriptionValue
statusItem statusNotStarted InProgress QualityCheck Returned Completed Skipped
lastAction.emailEmail address of the project contributor who made the last change to the item.The value is an email address.
nameItem file nameThe value is a name.
annotatorEmailThe assigned annotator’s email address.The value is an email address.
qaEmailThe assigned QA’s email address.The value is an email address.
priorityPriority scoreNumeric value

Instance and instance count

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

FieldDescriptionValue
typeInstance typeentity tag
classNameClass nameThe value is a class name.
attributes.nameAttribute nameThe value is an attribute name.
attributes.groupNameAttribute group nameThe value is an attribute group name.
createdBy.emailEmail address of the project contributor who created the instance.The value is an email address.
createdBy.roleRole of the project contributor who created the instance.Annotator QA Admin
updatedBy.emailEmail address of the project contributor who made the last change to the instance.The value is an email address.
updatedBy.roleRole of the project contributor who made the last change to the instance.Annotator QA Admin
createdAtDate when the instance was created.The value is a date with this format YYYY-MM-DD.
updatedAtDate when the instance was last updated.The value is a date with this format YYYY-MM-DD.

🚧

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 Happy and excited, the query will handle the word happy and the word excited separately. Instead, you can use symbols, such as underscores, to separate the words. So Happy and excited would be changed to happy_and_excited.

Folder

You can search folders by the following fields:

FieldDescriptionValue
folderNameFolder nameThe value is a name.
folderStatusFolder statusNotStarted InProgress Completed OnHold
Undefined

To search for root folders:

folder [insert operator here] root

Example: folder = root

📘

If the status of a folder has been changed, refresh the Explore tab for the queries to work correctly.

Free text

You can search free texts (freeText) this way:

freeText [insert operator here] text

Example: freeText = Product descriptions.

Random

To get a randomized subset of data:

OperatorDescriptionValue
randomUsed to get a randomized subset of dataNumeric value.

When you run a query with random, you’ll get a randomized subset of data. This will help you increase efficiency in checking the quality of the annotations and the dataset’s health.

So, if the query is metadata(status = InProgress ) random 50, 50 random items from the project that have the in In Progress status will be returned.

Custom metadata

You can search by custom metadata (customMetadata) this way:

FieldDescriptionValue
customMetadataCustom metadataDepending on the field type. Please check this page for more information.

Operators

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 statements are 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

📘

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

Sort list

You can sort the list in Data by:

FieldDescriptionValue
metadata.nameItem nameASC (ascending) DESC (descending)
metadata.statusItem statusASC (ascending) DESC (descending)
metadata.lastAction.dateDate when the item was last updated.ASC (ascending) DESC (descending)
metadata.qaEmailEmail address of the assigned QA.ASC (ascending) DESC (descending)
metadata.annotatorEmailEmail address of the assigned annotator.ASC (ascending) DESC (descending)
instanceCountThe 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.

Save query

To save a query:

  1. Type a query in the query bar.
  2. Click on the star at the right edge 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.
  • If you’ve successfully saved the query, you'll see this message: “You’ve successfully saved the query.”
  • If the query can’t be saved, you'll see this message: “Oops! Something went wrong.”

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.

📘

If you’ve successfully renamed the query, you'll see this message: “You’ve successfully renamed the query.”
If the query can’t be renamed, you'll see this message: “Oops! Something went wrong.”

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

📘

  • If you’ve successfully deleted the query, you'll see this message: “You’ve successfully deleted the query.”
  • If the query can’t be deleted, you'll see this message: “Oops! Something went wrong.”

Subsets

Add items to a subset

To add an item or multiple items to a subset:

  1. In Explore, select an item or multiple items.
  2. Click Add to subset.
  3. Choose an existing subset or create a new one. To create a new subset, type a non-existing name in the search bar and click Create subset.
  4. Click Save.

Copy items to a subset

To copy an item or multiple items from one subset to another:

  1. Go to the subset.
  2. Select an item or multiple items.
  3. Click the Copy/Move items button.
  4. Choose the subset where you want to copy the item(s).
  5. Click Copy.

📘

Messages

  • If you’ve successfully copied the items, you’ll see this message: You added [number of items] item(s) to the selected subset(s).
  • If the items are taking too long to be copied, you’ll see this message: You added [number of added items]/[number of total items] item(s) to the selected subset(s).
  • If something goes wrong, you’ll see this message: Oops! Something went wrong.

Move items from one subset to another

To move an item or multiple items from one subset to another:

  1. Go to the subset.
  2. Select an item or multiple items.
  3. Click the Copy/Move items button.
  4. Go to the Move tab.
  5. Choose the subset where you want to copy the item(s).
  6. Click Move.

📘

Messages

  • If you’ve successfully moved the items, you’ll see this message: You successfully moved [number of items] item(s).
  • If the items are taking too long to be moved, you’ll see this message: [number of updated items]/[number of total items] item(s) moved
  • If something goes wrong, you’ll see this message: Oops! Something went wrong.

View subset

To view all your subsets, click on Display Settings next to the search bar. You’ll find all your subsets under Subsets.

Delete a subset

To delete a subset:

  1. Find the subset you want to delete under Subsets in the left panel.
  2. Click on the three dots > Delete.
  3. In the popup, select Delete.

Delete items from a subset

To delete items from a subset:

  1. Select items in a subset.
  2. Click Remove From Subset.

📘

You can perform the following bulk actions in a subset: change the status of items, approve/disapprove items, set priority scores, and download a dataset.

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 at the bottom menu.
  3. Choose the status: Approve, Disapprove, or None.
  4. Click Change.

Set priority scores in bulk

To set the priority scores in bulk:

  1. Select multiple items.
  2. Click Priority scores.
  3. Choose a value.
  4. Click Set.

🚧

Annotators will receive the items with a higher priority score first.

Download items

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