abacusai.schema

Classes

Schema

A schema description for a feature

Module Contents

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, MESSAGE_LIST.

  • 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

name
feature_mapping
detected_feature_mapping
feature_type
detected_feature_type
data_type
detected_data_type
nested_features
point_in_time_info
deprecated_keys
__repr__()
to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict