Skip to content

featurebyte.Catalog.create_entity

create_entity(
name: str,
serving_names: List[str]
) -> Entity

Description

Registers a new Entity object in the catalog. An Entity object defines an entity type represented in tables of the catalog, allowing for automatic table joins, unit of analysis, and organization of features, feature lists, and use cases.

To create a new Entity object, you need to provide a name for the entity and its serving names.

An entity's serving name is the name of the unique identifier that is used to identify the entity during a preview or serving request. Typically, the serving name for an entity is the name of the primary key (or natural key) of the table that represents the entity.

For example, the serving names of a Customer entity could be 'CustomerID' and 'CustID'.

Parameters

  • name: str
    Entity name.

  • serving_names: List[str]
    List of accepted names for the unique identifier that is used to identify the entity during a preview or serving request.

Returns

  • Entity
    Newly created entity.

Examples

Create a new entity.

>>> entity = catalog.create_entity("customer", ["customer_id"])