SearchResult¶

class pyinaturalist.models.SearchResult(id=None, uuid=None, score=0, type=None, matches=_Nothing.NOTHING, record=None)¶

Bases: BaseModel

A search result of any type, based on the schema of GET /search.

Attributes

Name	Type	Description
id	`int`	Unique record ID
uuid	`str`	Unversally unique record ID
score	`float`	Search result rank
type	`str`	Search result type Options: `Place`, `Project`, `Taxon`, `User`
matches	`List`[`str`]	Search terms matched
record	`Union`[`Place`, `Project`, `Taxon`, `User`]	Search result object

record_name (`property`)	`str`	Alias for type-specific name/title field

Methods

__init__(id=None, uuid=None, score=0, type=None, matches=_Nothing.NOTHING, record=None)¶: Method generated by attrs for class SearchResult.

classmethod copy(obj)¶

Copy a model object. This is defined as a classmethod to easily initialize a subclass from a parent class instance. For copying an instance to the same type, copy.deepcopy() can be used.

Return type:: BaseModel

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).

Return type:: TypeVar(T, bound= BaseModel)

classmethod from_json_file(value)¶

Initialize a collection of model objects from a JSON string, file path, or file-like object

Return type:: List[TypeVar(T, bound= BaseModel)]

classmethod from_json_list(value, **kwargs)¶

Initialize a collection of model objects from an API response or response results

Return type:: List[TypeVar(T, bound= BaseModel)]

to_dict(keys=None, recurse=True)¶

Convert this object back to dict format

Parameters:

keys (Optional[List[str]]) – Only keep the specified keys (attribute names)
recurse (bool) – Recurse into nested model objects

Return type:

Dict[str, Any]