Client.search¶
Search resources globally (projects, datasets, notebooks, …).
Accepts limit. type and project_id raise ValidationError;
use collection list filters or filter results by .type.
Signature¶
search(query: str, **kwargs: Any) -> list[SearchResult]
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
query |
str |
yes | - |
**kwargs |
Any |
no | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
limit |
query |
integer |
no | 5 |
q |
query |
string |
yes | - |
Fields¶
| Field |
|---|
query |
**kwargs |
Return shape¶
HTTP 200 — OK
Schema: SearchResponse
| Field | Type | Required |
|---|---|---|
datasets |
array<SearchResultItem> |
yes |
instruments |
array<SearchResultItem> |
yes |
notebooks |
array<SearchResultItem> |
yes |
parameters |
array<SearchResultItem> |
yes |
projects |
array<SearchResultItem> |
yes |
reports |
array<SearchResultItem> |
yes |
tags |
array<SearchResultItem> |
yes |
Permission¶
Required permission: Any signed-in user
HTTP¶
GET /api/search/ (search)
Usage¶
client.search(query)