Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: correct the descriptions about the key of filters in Basic Search #1241

Merged
merged 1 commit into from
Apr 6, 2022
+3 −2
Merged

docs: correct the descriptions about the key of filters in Basic Search #1241

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/source/features/search/basic_search.rst
View file
Open in desktop
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