Skip to main content

module aixplain.modules.metadata

class MetaData​

method __init__​

__init__(
    name: str,
    dtype: DataType,
    storage_type: StorageType,
    data_column: Optional[str] = None,
    start_column: Optional[str] = None,
    end_column: Optional[str] = None,
    privacy: Optional[Privacy] = None,
    file_extension: Optional[FileType] = None,
    languages: List[Language] = [],
    dsubtype: DataSubtype = <DataSubtype.OTHER: 'other'>,
    id: Optional[str] = None,
    **kwargs
) → None

MetaData Class

Description: This class is used to stored the meta-information of the Data Class. It may be used to describe Data during the onboarding process of a corpus or dataset.

Args:

  • name (Text): Data Name
  • dtype (DataType): Data Type
  • storage_type (StorageType): Data Storage (e.g. text, local file, web link)
  • data_column (Optional[Text], optional): Column index/name where the data is on a structured file (e.g. CSV). Defaults to None.
  • start_column (Optional[Text], optional): Column index/name where the start indexes is on a structured file (e.g. CSV). Defaults to None.
  • end_column (Optional[Text], optional): Column index/name where the end indexes is on a structured file (e.g. CSV). Defaults to None.
  • privacy (Optional[Privacy], optional): Privacy of data. Defaults to None.
  • file_extension (Optional[FileType], optional): File extension (e.g. CSV, TXT, etc.). Defaults to None.
  • languages (List[Language], optional): List of languages which the data consists of. Defaults to [].
  • dsubtype (DataSubtype, optional): Data subtype (e.g., age, topic, race, split, etc.), used in datasets metadata. Defaults to Other.
  • id (Optional[Text], optional): Data ID. Defaults to None.