Skip to main content

name

Definition

Every concept in the Knowledge Base layer has either a name or a display_name.

The way you should think about name is as a combination of display_name and synonym.

In other words, like display_name, it is the name that gets displayed to the user in titles, filters, autocomplete and the Knowledge Graph view. And like synonym, the name defines how users can refer to this concept in questions.

Usage

The property name can be used in class, relationship, entity and all attributes. It is a single String value per language (no Array is allowed) and is defined with a language tag (en for English, it for Italian, de for German, fr for French or all for all languages).

Example:

kb {
class Customer {
name.en: "Customer"
name.de: "Kunde"

...
}
}

In the case of Entities, the name attribute is derived dynamically from the name_sql specified in the class.