abacusai.schema

Classes

NestedFeatureSchema

A schema description for a nested feature

PointInTimeFeatureInfo

A point-in-time infos for a feature

AbstractApiClass

Schema

A schema description for a feature

Module Contents

class abacusai.schema.NestedFeatureSchema(client, name=None, featureType=None, featureMapping=None, dataType=None, detectedFeatureType=None, sourceTable=None, pointInTimeInfo={})

Bases: abacusai.return_class.AbstractApiClass

A schema description for a nested feature

Parameters:

  • client (ApiClient) – An authenticated API Client instance

  • name (str) – The unique name of the column

  • featureType (str) – Feature Type of the Feature

  • featureMapping (str) – The Feature Mapping of the feature

  • dataType (str) – Data Type of the Feature

  • detectedFeatureType (str) – The detected feature type for this feature

  • sourceTable (str) – The source table of the column

  • pointInTimeInfo (PointInTimeFeatureInfo) – Point in time information for this feature

__repr__()

Return repr(self).

to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict

class abacusai.schema.PointInTimeFeatureInfo(client, expression=None, groupName=None)

Bases: abacusai.return_class.AbstractApiClass

A point-in-time infos for a feature

Parameters:

  • client (ApiClient) – An authenticated API Client instance

  • expression (str) – SQL aggregate expression which can convert a sequence of rows into a scalar value.

  • groupName (str) – The group name this point-in-time feature belongs to.

__repr__()

Return repr(self).

to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict

class abacusai.schema.AbstractApiClass(client, id)
__eq__(other)

Return self==value.

_get_attribute_as_dict(attribute)
class abacusai.schema.Schema(client, name=None, featureMapping=None, detectedFeatureMapping=None, featureType=None, detectedFeatureType=None, dataType=None, detectedDataType=None, nestedFeatures={}, pointInTimeInfo={})

Bases: abacusai.return_class.AbstractApiClass

A schema description for a feature

Parameters:

  • client (ApiClient) – An authenticated API Client instance

  • name (str) – The unique name of the feature.

  • featureMapping (str) – The mapping of the feature. The possible values will be based on the project’s use-case. See the (Use Case Documentation)[https://api.abacus.ai/app/help/useCases] for more details.

  • detectedFeatureMapping (str) – Detected feature mapping for this feature

  • featureType (str) – The underlying data type of each feature: CATEGORICAL, CATEGORICAL_LIST, NUMERICAL, TIMESTAMP, TEXT, EMAIL, LABEL_LIST, ENTITY_LABEL_LIST, PAGE_LABEL_LIST, JSON, OBJECT_REFERENCE, MULTICATEGORICAL_LIST, COORDINATE_LIST, NUMERICAL_LIST, TIMESTAMP_LIST, ZIPCODE, URL, PAGE_INFOS, PAGES_DOCUMENT, TOKENS_DOCUMENT.

  • detectedFeatureType (str) – The detected feature type for this feature

  • dataType (str) – The underlying data type of each feature: INTEGER, FLOAT, STRING, DATE, DATETIME, BOOLEAN, LIST, STRUCT, NULL, BINARY.

  • detectedDataType (str) – The detected data type for this feature

  • nestedFeatures (NestedFeatureSchema) – List of features of nested feature

  • pointInTimeInfo (PointInTimeFeatureInfo) – Point in time information for this feature

__repr__()

Return repr(self).

to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict