Skip to content

Data attributes

Data attributes are the entities needed to describe ordering, static values and generic attributes. All the described entities are available in the igenius_adapters_sdk.entities.data.

Order attribute

Determines the order of the result data if provided.

class OrderByDirection(str, Enum):
    DESC = 'desc'
    ASC = 'asc'

class OrderByAttribute(BaseModel):
    alias: str
    direction: OrderByDirection = OrderByDirection.ASC

Static value

Provides raw data from an attribute.

class StaticValueAttribute(BaseModel):
    value: str
    alias: str
    default_bin_interpolation: Optional[Any]

Info

default_bin_interpolation value will be used for the empty bins intrpoleted by Bin interpolation helper.

Base attribute

Attribute model that is followed by Aggregation and GroupBy Attribute.

class BaseAttribute(BaseModel, abc.ABC):
    attribute_uri: uri.AttributeUri
    alias: str

Aggregation attribute

Provides aggregated data as a result.

class AggregationAttribute(BaseAttribute):
    function_uri: FunctionUri
    default_bin_interpolation: Optional[Any]

Info

default_bin_interpolation value will be used for the empty bins intrpoleted by Bin interpolation helper.

Binning attribute

Provides binned data as a result.

class BinningAttribute(BaseAttribute):
    function_uri: FunctionUri

Last update: April 7, 2021