SearchResult¶
- class pyinaturalist.models.SearchResult(id=None, score=0, type=None, matches=NOTHING, record=None)¶
Bases:
pyinaturalist.models.base.BaseModel
A search result of any type, based on the schema of GET /search.
Attributes
Name
Type
Description
id
Unique record ID
score
Search result rank
type
Search result type
Options:
Place
,Project
,Taxon
,User
matches
Search terms matched
record
Search result object
record_name (
property
)Alias for type-specific name/title field
Methods
- __init__(id=None, score=0, type=None, matches=NOTHING, record=None)¶
Method generated by attrs for class SearchResult.
- classmethod from_json(value, **kwargs)¶
Initialize a single model object from an API response or response result.
Omits any invalid fields and
None
values, so default factories are used instead (e.g. for empty dicts and lists).
- classmethod from_json_file(value)¶
Initialize a collection of model objects from a JSON string, file path, or file-like object
- classmethod from_json_list(value)¶
Initialize a collection of model objects from an API response or response results