SearchResource (client.search)¶
Endpoints: • search.searchAnything
.invalidate_cache()¶
Clear the SWR cache for all resources.
Signature¶
await client.search.invalidate_cache() -> 'None'
.query()¶
Global search across all entity types (users, countries, companies, MUs, articles).
Args: search_text: The search query. Must be at least 1 character.
Returns: SearchResults containing a list of matched entities with type and ID.
Signature¶
await client.search.query(search_text: 'str') -> 'SearchResults'
Parameters¶
| Name | Type | Default |
|---|---|---|
search_text |
str |
Required |
Return Models¶
SearchResult¶
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
type |
string |
Optional |
SearchResults¶
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
results |
array[SearchResult] |
Optional |
total |
integer |
Optional |
.search_mus()¶
Search military units.
Signature¶
await client.search.search_mus(query: 'str') -> 'list[SearchResult]'
Parameters¶
| Name | Type | Default |
|---|---|---|
query |
str |
Required |
Return Models¶
SearchResult¶
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
type |
string |
Optional |
.search_users()¶
Search users.
Signature¶
await client.search.search_users(query: 'str') -> 'list[SearchResult]'
Parameters¶
| Name | Type | Default |
|---|---|---|
query |
str |
Required |
Return Models¶
SearchResult¶
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
type |
string |
Optional |