bayesline.api.equity.DimensionDescriptor

model DimensionDescriptor

How a report dimension is ordered and which levels form its hierarchy.

Fields

Field	Type	Required	Default
hierarchies	list[LevelHierarchy]	No	factory
kind	Literal[‘ordered’, ‘nominal’]	Yes
label	str	Yes
levels	list[str]	Yes
name	str	Yes

field hierarchies: list[LevelHierarchy] [Optional]

The chains the levels nest in, each coarsest to finest; every column of levels sits in at least one. Empty when the dimension declares none.

field kind: Literal['ordered', 'nominal'] [Required]

Whether members are ordered (dates) or nominal (categories).

field label: str [Required]

A display name for the dimension.

field levels: list[str] [Required]

The hierarchy level columns from coarsest to finest.

field name: str [Required]

The dimension name.