Skip to main content

aip_sdk.DimensionSpec

aip_sdk.DimensionSpec

A slice of the dataset the methodology requires: a column plus the values expected in it.

vocabulary is required but may be empty, so an author declares the values the methodology expects even when that declaration is "none".

column cannot be checked here — GDI schemas are strict=False, so it may name a declared optional column or one only this methodology's data carries. Its existence is verified against a real dataframe at promotion.

aip_sdk.DimensionSpec.column​

aip_sdk.DimensionSpec.column: str = Field(min_length=1, max_length=MAX_DIMENSION_TEXT_LENGTH)

No docstring is defined in the source.

aip_sdk.DimensionSpec.model_config​

aip_sdk.DimensionSpec.model_config = ConfigDict(extra='forbid')

No docstring is defined in the source.

aip_sdk.DimensionSpec.name​

aip_sdk.DimensionSpec.name: str = Field(min_length=1, max_length=MAX_DIMENSION_TEXT_LENGTH)

No docstring is defined in the source.

aip_sdk.DimensionSpec.required​

aip_sdk.DimensionSpec.required: bool = False

No docstring is defined in the source.

aip_sdk.DimensionSpec.vocabulary​

aip_sdk.DimensionSpec.vocabulary: list[str]

No docstring is defined in the source.