abacusai.schema

Module Contents

Classes

Schema

A schema description for a feature

class abacusai.schema.Schema(client, name=None, featureMapping=None, featureType=None, dataType=None)

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.

  • featureType (str) – The underlying data type of each feature: CATEGORICAL, CATEGORICAL_LIST, NUMERICAL, TIMESTAMP, TEXT, EMAIL, LABEL_LIST, JSON, OBJECT_REFERENCE. Refer to the (guide on data types)[https://api.abacus.ai/app/help/class/FeatureType] for more information.

  • dataType (str) – The underlying data type of each feature: INTEGER, FLOAT, STRING, DATE, DATETIME, BOOLEAN, LIST, STRUCT. Refer to the (guide on data types)[https://api.abacus.ai/app/help/class/DataType] for more information.

__repr__(self)

Return repr(self).

to_dict(self)

Get a dict representation of the parameters in this class

Returns

The dict value representation of the class parameters

Return type

dict