abacusai.use_case_requirements

Module Contents

Classes

UseCaseRequirements

Use Case Requirements

class abacusai.use_case_requirements.UseCaseRequirements(client, datasetType=None, name=None, description=None, required=None, allowedFeatureMappings=None, allowedNestedFeatureMappings=None)

Bases: abacusai.return_class.AbstractApiClass

Use Case Requirements

Parameters
  • client (ApiClient) – An authenticated API Client instance

  • datasetType (str) – The project-specific enum value of the dataset type

  • name (str) – The user-friendly name of the dataset type

  • description (str) – The description of the dataset type

  • required (bool) – True if the dataset type is required for this project

  • allowedFeatureMappings (dict) – A collection of key value pairs with each key being a column mapping enum (see a list of column mapping enums here) and each value being in the following dictionary format: { “description”: str, “allowed_feature_types”: feature_type_enum, “required”: bool}

  • allowedNestedFeatureMappings (dict) – A collection of key value pairs with each key being a column mapping enum (see a list of column mapping enums here) and each value being in the following dictionary format: { “description”: str, “allowed_feature_types”: feature_type_enum, “required”: bool}

__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