Synonym

Definition

Every concept in the Knowledge Base layer can have a synonym defined.

Similar to name, synonym lets you define alternative ways to refer to a concept.

The AI agent already knows general business language, but it doesn't know your company's internal vocabulary: product nicknames, team jargon, abbreviations. Defining synonyms gives the agent your terminology, so it can resolve those terms to the right concepts when answering questions. Synonyms also show up in autocomplete, helping users discover concepts under the names they actually use.

Usage

The property synonym can be used in class, relationship, entity and all attributes. It is a single String value or multiple String values (as an Array) per language and is defined with a language tag (en for English, de for German, fr for French, it for Italian, es for Spanish, pt for Portuguese, or all for all languages).

Example:

Single synonym in English for a class.

kb {
    class Customer {
        name.en: "Customer" 
        
        synonym.en: "Client"
        ...
    }
}

Multiple synonyms in English for a class.

kb {
    class Customer {
        name.en: "Customer" 
        
        synonym.en: ["Client", "Consumer"]
        ...
    }
}

In the case of Entities, the synonym property can be derived dynamically from the synonym_sql specified in the class or manually added for each entity.