Module aivis_engine_v2_base_sdk_python.tabular_data

Classes

class EngineTabularData

Interface for handling engine tabular data.

Ancestors

  • abc.ABC

Methods

def add_boolean_column(self, column_id: str, data: List[DtoBooleanCell])

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Add boolean column to this tabular data context. Calling this method on an existing column with respective type allows to add data to this column (overriding duplicated row ids). Trying to add data to an already existing synthesized column or a column of wrong type will result in an exception.

Parameters

column_id : str
Column-ID as string
data : List[DtoBooleanCell]
List of boolean cells
def add_float_column(self, column_id: str, data: List[DtoFloatCell])

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Add float column to this tabular data context. Calling this method on an existing column with respective type allows to add data to this column (overriding duplicated row ids). Trying to add data to an already existing synthesized column or a column of wrong type will result in an exception.

Parameters

column_id : str
Column-ID as string
data : List[DtoFloatCell]
List of float cells
def add_string_column(self, column_id: str, data: List[DtoStringCell])

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Add string column to this tabular data context. Calling this method on an existing column with respective type allows to add data to this column (overriding duplicated row ids). Trying to add data to an already existing synthesized column or a column of wrong type will result in an exception.

Parameters

column_id : str
Column-ID as string
data : List[DtoStringCell]
List of string cells
def destroy(self)

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Destroy this tabular data context and all its data. It's always safe to destroy a data context. Internally the destruction only takes place after all references to this context have been released.

def get_boolean_column(self, column_id: str) ‑> List[DtoBooleanCell]

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Get boolean data of a column with given column_id from this tabular data context. Requesting a non-existing column or a column of wrong type will result in an exception.

Parameters

column_id : str
Column-ID as string

Returns

List[DtoBooleanCell]
List of boolean cells
def get_float_column(self, column_id: str) ‑> List[DtoFloatCell]

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Get float data of a column with given column_id from this tabular data context. Requesting a non-existing column or a column of wrong type will result in an exception.

Parameters

column_id : str
Column-ID as string

Returns

List[DtoFloatCell]
List of float cells
def get_string_column(self, column_id: str) ‑> List[DtoStringCell]

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Get string data of a column with given column_id from this tabular data context. Requesting a non-existing column or a column of wrong type will result in an exception.

Parameters

column_id : str
Column-ID as string

Returns

List[DtoStringCell]
List of string cells
def read_files(self, config_json: str)

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Read and ingest files to tabular data context.

Parameters

config_json : str
DtoTabularFilesReaderConfig as JSON string