:py:mod:`abacusai.schema`
=========================

.. py:module:: abacusai.schema


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   abacusai.schema.Schema




.. py:class:: Schema(client, name=None, featureMapping=None, detectedFeatureMapping=None, featureType=None, detectedFeatureType=None, dataType=None, detectedDataType=None)

   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`

   A schema description for a feature

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param name: The unique name of the feature.
   :type name: str
   :param featureMapping: 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.
   :type featureMapping: str
   :param detectedFeatureMapping: Detected feature mapping for this feature
   :type detectedFeatureMapping: str
   :param featureType: The underlying data type of each feature:  CATEGORICAL,  CATEGORICAL_LIST,  NUMERICAL,  TIMESTAMP,  TEXT,  EMAIL,  LABEL_LIST,  JSON,  OBJECT_REFERENCE,  MULTICATEGORICAL_LIST,  COORDINATE_LIST,  NUMERICAL_LIST,  TIMESTAMP_LIST.  Refer to the (guide on data types)[https://api.abacus.ai/app/help/class/FeatureType] for more information.
   :type featureType: str
   :param detectedFeatureType: The detected feature type for this feature
   :type detectedFeatureType: str
   :param dataType: The underlying data type of each feature:  INTEGER,  FLOAT,  STRING,  DATE,  DATETIME,  BOOLEAN,  LIST,  STRUCT,  NULL.  Refer to the (guide on data types)[https://api.abacus.ai/app/help/class/DataType] for more information.
   :type dataType: str
   :param detectedDataType: The detected data type for this feature
   :type detectedDataType: str

   .. py:method:: __repr__()

      Return repr(self).


   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict



