Skip to content

3. Register Entities

What is an Entity?

In FeatureByte, an Entity represents real-world objects or concepts. While entities are typically associated with a primary key or foreign key in the data, they can also be represented by categorical columns that define groups of related objects. For example, a City entity may represent multiple customers, and a Product Group entity may encompass multiple products, even though neither is explicitly used as a foreign key.


Step 1: Identify Entities in Your Data

In the Credit Default dataset, we identified four entities.

Name Description
Client A client of the credit institution
New Application A new loan application
Prior Application A prior loan application
Consumer Loan A Consumer loan

If you have registered the cash loan table too, you must register a 'Cash loan' entity.


Step 2: Decide their Serving Name

An Entity's Serving Name is the unique identifier used to recognize the entity during a serving request in FeatureByte. You can choose any name that suits your needs, provided it is not already assigned to another entity.

Name Description Serving Name
Client A client of the credit institution CLIENT_ID
New Application A new loan application NEW_APPLICATION_ID
Prior Application A prior loan application PRIOR_APPLICATION_ID
Consumer Loan A Consumer loan CONSUMER_LOAN_ID

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's Name, its Serving Name and optionally its description.
  3. Confirm by clicking Save Entity.

Register Entities


Register Entities


Register Entities


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 NEW_APPLICATION,

  • APPLICATION_ID represents New Application.
  • CLIENT_ID identifies Client.

Register Entities In Table


In PRIOR_APPLICATIONS,

  • APPLICATION_ID represents Prior Application.
  • CLIENT_ID identifies Client.

Register Entities In Table


In CONSUMER_LOAN_STATUS,

  • LOAN_ID represents Consumer Loan.
  • CLIENT_ID identifies Client.

Register Entities In Table


In CONSUMER_INSTALLMENTS,

  • LOAN_ID represents Consumer Loan.

Register Entities In Table


Step 6: Review Entities Relationships

Verify the relationships established by the tagging.

Register Entities

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

Table Catalog

Table Diagram