dialogy.types.entity.base_entity package

Module contents

Module provides access to a base class to create other entities.

classDiagram direction LR BaseEntity --|> NumericalEntity BaseEntity --|> CreditCardNumberEntity BaseEntity --|> CurrencyEntity BaseEntity --|> TimeEntity BaseEntity --|> KeywordEntity BaseEntity --|> DurationEntity BaseEntity --|> PeopleEntity TimeEntity --|> TimeIntervalEntity NumericalEntity ..> TimeEntity: as_time DurationEntity ..> TimeEntity: as_time class BaseEntity { +Dict[str, int] range +str body +str dim +int alternative_index +str type +str entity_type +float score +Any value +List~Any~ values +List~str~ parsers +bool latent +Any get_value() +Dict[str, Any] json() $BaseEntity from_dict(d) } class CurrencyEntity { +str unit +Any get_value() +CurrencyEntity from_duckling(d) } class CreditCardNumberEntity { +str issuer +from_duckling(d: dict, idx: int) +CreditCardNumberEntity from_duckling(d) } class KeywordEntity { } class DurationEntity { +str unit +dict normalized +DurationEntity from_duckling(d) } class NumericalEntity { +NumericalEntity from_duckling(d) } class PeopleEntity { +str unit +PeopleEntity from_duckling(d) } class TimeEntity { +str grain +datetime get_value() +TimeEntity from_duckling(d) }

class BaseEntity(body, dim=None, parsers=NOTHING, score=None, alternative_index=None, alternative_indices=None, latent=False, values=NOTHING, value=None, entity_type=None, *, range, type='value')

Bases: object

Base Entity Type.

This class is meant for subclassing. Its intended purpose is to define a base for all entity types.

add_parser(plugin)

Update parsers with the postprocessor function name

This is to identify the progression in which the plugins were applied to an entity. This only helps in debugging and has no production utility.

Parameters

plugin (Plugin) – The class that modifies this instance. Preferably should be a plugin.

Returns

Calling instance with modifications to parsers attribute.

Return type

BaseEntity

alternative_index: Optional[int]

alternative_indices: Optional[List[int]]

body: str

copy()

Create a deep copy of the instance and return.

This is needed to prevent mutation of an original entity. :return: A copy of BaseEntity that calls this method. :rtype: BaseEntity

dim: Optional[str]

entity_type: Optional[str]

classmethod from_dict(dict_, reference=None)

Return type

BaseEntity

classmethod from_duckling(d, alternative_index, **kwargs)

Return type

Optional[BaseEntity]

get_value()

Get value of an entity.

The structure of an entity conceals the value in different data structures. This is sugar for access.

Parameters

reference (Any) – Picking value/values from a reference object.

Raises

• IndexError – If values is not a list.

• KeyError – If each element in values is not a dict.

Returns

Arbitrary instance, subclasses should override and return specific types.

Return type

BaseEntity

json(skip=None, add=None)

Convert the object to a dictionary.

Applies some expected filters to prevent information bloat.

Add section for skipping more properties using const.SKIP_ENTITY_ATTRS + [“”]

Parameters

• skip (Optional[List[str]]) – Names of attributes that should not be included while converting to a dict. Defaults to None.

• add (Optional[List[str]]) – Names of attributes that should be included while converting to a dict. Defaults to None.

Returns

Dictionary representation of the object

Return type

Dict[str, Any]

latent: bool

parsers: List[str]

range: Dict[str, int]

score: Optional[float]

type: str

value: Any

values: List[Dict[str, Any]]

entity_synthesis(entity, property_, value)

Update a property=`property_` of a BaseEntity, with a given value=`value`.

Warning

This is an unsafe method. Use with caution as it doesn’t check the type of the new value being type safe.

Parameters

• entity (BaseEntity) – A BaseEntity instance.

• property (str) – An attribute of BaseEntity that should be changed.

• value (Any) – The value to replace within a BaseEntity instance.

Returns

A copy of BaseEntity instance used in this function with modifications.

Return type

BaseEntity