Skip to main content

OntologyAttribute

One entity attribute as the catalog shows it. key is server-derived from the EntityType schema (metadata.keys) and can never be hidden — the join axis has to stay in the frame. visible=False narrows the LLM surface only (catalog / match / result frame); traversal still reads the column. dictionary sits on the display attribute people type, never on the key: a matched surface resolves to the key (D6 — measured 0/2 with the dictionary on the key, the model matches aliases on label). description is imported from the EntityType field's metadata.description and may be overridden by curation, which is what a model whose fields carry no metadata depends on: without it the catalog hands the LLM a bare physical name (hbp_knd_cd) and the only way to learn what its codes mean is to query for them. values / samples are the value-grounding pair Column already has and carry the same meanings — values the exhaustive low-card domain, samples illustrative examples that ground the literal format. Both are curator-owned: an EntityType schema has no such concept, so an import never supplies them and a sync never overwrites them. Both are suppressed in the catalog for a dictionary-backed attribute, exactly as they are on a column, because one leaked canonical code primes the model to emit codes instead of surface forms.

nameName (string)required
data_type object
anyOf
nameName (string)required

Arrow type name, e.g. 'int64', 'utf8', 'decimal'

unit object
anyOf
string

Possible values: [s, ms, us, ns]

timezone object
anyOf
string
precision object
anyOf
integer

Possible values: >= 1 and <= 76

scale object
anyOf
integer

Possible values: >= 0

label object
anyOf
string
description object
anyOf
string
synonymsstring[]
keyKey (boolean)
Default value: false
visibleVisible (boolean)
Default value: true
dictionary object
anyOf
builtin object
anyOf
object
external object
anyOf
string
valuesstring[]
samplesstring[]
displayDisplay (boolean)
Default value: false
OntologyAttribute
{
  "name": "string",
  "data_type": {
    "name": "string",
    "unit": "s",
    "timezone": "string",
    "precision": 0,
    "scale": 0
  },
  "label": "string",
  "description": "string",
  "synonyms": [
    "string"
  ],
  "key": false,
  "visible": true,
  "dictionary": {
    "builtin": {},
    "external": "string"
  },
  "values": [
    "string"
  ],
  "samples": [
    "string"
  ],
  "display": false
}