Skip to content

featurebyte.Entity.serving_names

serving_names: List[str]

Description

Lists the serving names of an Entity object. 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 convenience, an entity can have multiple serving names but the unique identifier should remain unique.

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

Returns

  • List[str]
    Serving names of the entity.

Examples

>>> entity = catalog.get_entity("grocerycustomer")
>>> entity.serving_names
['GROCERYCUSTOMERGUID']

See Also