Skip to content

3. Register Entities

In FeatureByte, an "entity" models real-world objects and ideas. These entities are often represented by unique identifiers in the data but not necessarily. An entity can be a group of entities, such as a City, a Product Group, etc... It can also be seen as a level of analysis you are interested in.

Step 1: Identify Entities in Your Data

In the Grocery dataset, we identified six entities.

Name Description
customer A grocery customer
invoice A record of the customer's purchase
item An individual item on the invoice
product A product available in the store for purchase
productgroup A category or group a product falls under
frenchstate A region in France

Step 2: Decide their Serving Name

An Entity's Serving Name is the name of the unique identifier used to identify the entity during a serving request in FeatureByte. It can be any name you find convenient as long as it is not used by another entity.

Name Description Serving Name
customer A grocery customer GROCERYCUSTOMERGUID
invoice A record of the customer's purchase GROCERYINVOICEGUID
item An individual item on the invoice GROCERYINVOICEITEMGUID
product A product available in the store for purchase GROCERYPRODUCTGUID
productgroup A category or group a product falls under PRODUCTGROUP
frenchstate A region in France FRENCHSTATE

Step 3: Register Entities

Navigate to the Entity catalog from the 'Explore' section of the menu.

Register Entities

Repeat this for each entity:

  1. Click Register Entities
  2. Fill in the form: the entity Name, its Serving Name and optionally its description
  3. Confirm by clicking "Save Entity"

Register Entities

Step 4: Review Registered Entities

Verify the registration by checking the Entity Catalog under the 'Explore' section.

Register Entities

Step 5: Tag Columns Representing Entities

From the menu, navigate to the 'Explore' section and access the Table catalog.

Table Description

For each table, navigate to the 'Columns' tab and associate relevant columns with the entities they represent.

Tag Entity

In GROCERYINVOICE,

  • GroceryInvoiceGuid identifies invoice
  • GroceryCustomerGuid represents customer

Register Entities In Table

In INVOICEITEMS,

  • GroceryInvoiceItemGuid identifies item
  • GroceryInvoiceGuid represents invoice
  • GroceryProductGuid represents product

Register Entities In Table

In GROCERYCUSTOMER,

  • GroceryCustomerGuid identifies customer
  • State represents frenchstate

Register Entities In Table

In GROCERYPRODUCT,

  • GroceryProductGuid identifies product
  • ProductGroup represents productgroup

Register Entities In Table

Step 6: Review Entities Relationships

Verify the relationships established by the tagging.

Register Entities

Navigate to the Table Catalog, click the diagram icon to verify the table diagram established by the tagging.

Table Catalog

Register Entities