abacusai.schema
===============

.. py:module:: abacusai.schema


Classes
-------

.. autoapisummary::

   abacusai.schema.NestedFeatureSchema
   abacusai.schema.PointInTimeFeatureInfo
   abacusai.schema.AbstractApiClass
   abacusai.schema.Schema


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

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

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


   A schema description for a nested feature

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param name: The unique name of the column
   :type name: str
   :param featureType: Feature Type of the Feature
   :type featureType: str
   :param featureMapping: The Feature Mapping of the feature
   :type featureMapping: str
   :param dataType: Data Type of the Feature
   :type dataType: str
   :param detectedFeatureType: The detected feature type for this feature
   :type detectedFeatureType: str
   :param sourceTable: The source table of the column
   :type sourceTable: str
   :param pointInTimeInfo: Point in time information for this feature
   :type pointInTimeInfo: PointInTimeFeatureInfo


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



.. py:class:: PointInTimeFeatureInfo(client, expression=None, groupName=None)

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


   A point-in-time infos for a feature

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param expression: SQL aggregate expression which can convert a sequence of rows into a scalar value.
   :type expression: str
   :param groupName: The group name this point-in-time feature belongs to.
   :type groupName: 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



.. py:class:: AbstractApiClass(client, id)

   .. py:method:: __eq__(other)

      Return self==value.



   .. py:method:: _get_attribute_as_dict(attribute)


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

   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,  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.
   :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,  BINARY.
   :type dataType: str
   :param detectedDataType: The detected data type for this feature
   :type detectedDataType: str
   :param nestedFeatures: List of features of nested feature
   :type nestedFeatures: NestedFeatureSchema
   :param pointInTimeInfo: Point in time information for this feature
   :type pointInTimeInfo: PointInTimeFeatureInfo


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



