Sort & Filters

For a python SDK usage of sort & filters go to Basic SDK Sort & Filters

Sort & Filter is part of the Dataset Browser that enables you to filter items based on the below parameters.
Enter the Dataset Browser by clicking on the dataset page or project dashboard, and clicking on the “BROWSE” icon of a dataset.

Using different filters together will return the items based on the method AND

For example, if the user "John Doe" uses Item status:"Annotated" + Contributor:”john@doe.ai”+ Annotation type: “Box” the returned items will include all the items that are annotated, have Box annotation and have john@doe.ai as an annotator in one or more of the annotations.

Directories

• You can select a directory to filter the items in that directory. Selections will be made by a dropdown list or by inputting the name of the directory (starting with “/”) and the auto-complete feature will help you find the relevant directory.
• Multiple directories can be selected to show aggregation from all selected directories.

File Name

• This filter is searching items by their “filename”

  Filename concatenates 2 fields: “name” platform item name & “dir” path of the item. For example, if you input “dog” in this field, it will return all items that have “dog” in the “dir” and “name”

• Multiple filenames will return values based on AND. For example you use “jpg” and “dog” the results will include all the items that have both values in the filename

Creation Time

• The “From…” field will return the items uploaded to the platform from that given date
• The “To…” field will return the items uploaded to the platform before that given date

Item Size

Avalable size units are KB, MB and GB.

• The “Min…” field will return the items of larger number from the given size
• The “Max…” field will return the items of smaller number from the given size

Tasks

• Filter items by task names they are assigned to.
• Multiple inputs cannot be used since the method is based on AND

File Type

• Filter is based on the item type. For example “png” will return all png files and “mp4” will return all mp4 files
• Multiple inputs cannot be used since the method is based on AND

Item Media Type

• Filter is based on the item media type. For example “image/png” will return all png images and “video/mp4” will return all mp4 videos
• you can also just write "image" or "video" to filter images and video items.
• Multiple inputs cannot be used since the method is based on AND

Item Status

This input is a radio button for selecting an option 1 out of many so users can select one option

• “All” will return all items in the Dataset
• “Annotated” will return all the annotated items in the Dataset
• “Not Annotated” will return all the unannotated items in the Dataset
• “Discarded” will return all the discarded items in the Dataset

Assignment Status

Mark each status to filter by:

• Assigned/Unassigned: If an item is Assigned to a Task
• Completed/Not Completed: If an item was marked "Completed" after an Annotation Task
• Approved/Not Approved: If an item was marked "Approved" after a QA Task
• Completed and Approved: If an item was marked "Completed Approved" after an Annotation Task and a QA Task

Labels

• This filter will return the items based on the selected Annotations that are saved in the item.

• Multiple inputs will return items based on the method OR .

  For example, if you input “dog” and “cat” the filter will return all items that have “dog” Annotations and all the items that have “cat” Annotations.

Annotation Types

• Selecting from the dropdown list will return all items of the selected tool.

• Inputting “Note” will return all the items that have note annotations

• Multiple inputs will return items based on the method OR .

  For example, if you input “Box” and “Point” the filter will return all items that have “Box” Annotations and all the items that have “Point” Annotations.

  See Annotation Tools for reference.

Contributors

• Filters will return all items annotated by the selected Contributor.
• Multiple inputs will return items based on the method OR .

Approved by

• Filters will return all items approved by the selected Contributor.
• Multiple inputs will return items based on the method OR .

Completed by

• Filters will return all items completed by the selected Contributor.
• Multiple inputs will return items based on the method OR .

Item Metadata

Filter items based on the metadata of an item

• Text will be used for values that are texts
• Number will be used for values that are numbers

Key: user
Value (case sensitive): Hello

For example searching items that have the word “Hello” under “user,” a returned item would be:

{
    "system": {
        "originalname": "name2.png",
        "size": 675834,
        "encoding": "7bit",
        "mimetype": "image/png",
        "annotationStatus": []},
    "user": "Hello"
}

Annotation Metadata

Filter items based on the metadata of an Annotations in items

• Text will be used for values that are texts

• Number will be used for values that are numbers

  status is the annotation status, options: approved/issue/review

  description is the annotation description, is is free text and case sensitive

"metadata": {
        "system": {
            "status": "approved",
            "startTime": 0,
            "endTime": 1,
            "frame": 0,
            "endFrame": 1,
            "snapshots_": [
            ......
            ],
            "automated": false,
            "isOpen": false,
            "system": false,
            "description": "Happy dog"
    }
}