Skip to content

Commit

Permalink
docs: correct the descriptions about the key of filters in Basic Search
Browse files Browse the repository at this point in the history
  • Loading branch information
graczhual committed Apr 6, 2022
1 parent 534ff59 commit 3ffc10a
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/source/features/search/basic_search.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ A BasicSearchJob can be created by :func:`~tensorbay.client.version.BasicSearch.

.. note::
``filters``: The list of basic search criteria whose format is (key, operator, value, label_type).
* key: The keyword of filters, which could be "segment", "size", "withLabel", "frame", "sensor", "category", "attribute" or "dataRemotePath".
* | key: The key of filters, which could be "segment", "size", "withLabel", "frame", "sensor", "category", "attribute" or "keyword".
Here, the meaning of the "keyword" is the remote path of the data, such as "cat_01.jpg".
* operator: The operational relationship between the key and value. The supported operators are "like", "in", "=", ">", "<", ">=" and "<=".
* value: The value of filters.
* label_type:It only needs to be used if the key is "category" or "attribute", indicating the label type to which the category or attribute belongs.
Expand Down Expand Up @@ -73,7 +74,7 @@ A BasicSearchJob can be created by :func:`~tensorbay.client.version.BasicSearch.
* - "attribute"
- "in"
- dict
* - "dataRemotePath"
* - "keyword"
- "like", "="
- string

Expand Down

0 comments on commit 3ffc10a

Please sign in to comment.