Entity
EntityInterface
Bases: ABC
Abstract interface for entities in the Monarch KG
get_entity
abstractmethod
Retrieve a specific entity by exact ID match, with optional extras
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id |
str
|
id of the entity to search for. |
required |
get_association_counts |
bool
|
Whether to get a count of associations for the entity. Defaults to False. |
False
|
get_hierarchy |
bool
|
Whether to get the entity's heirarchy in the data model. Defaults to False. |
False
|
Raises:
| Type | Description |
|---|---|
NotImplementedError
|
Use a specific implementation (see the documentation for a list of implementations) |
Returns:
| Name | Type | Description |
|---|---|---|
Entity |
Entity
|
Dataclass representing results of an entity search. |